Merge pull request 'v25.12.0-alpha.1' (#5) from config-change-251130 into main

Reviewed-on: #5

.gitignore

@@ -1,5 +1,6 @@
 /dist/
 /.env*
 /node_modules/
-/package-lock.json
 /config.ts
+/config/**
+!/config/example.config.yaml

CHANGELOG.md

@@ -1,3 +1,17 @@
+# 25.12.0-alpha.1
+- New: configをTypeScriptファイルからyamlへ移行しました
+  - Note: 新しいファイルパスはconfig/config.yamlです
+  - New: それに伴って複数の依存関係が追加されました
+  - Delete: また、examples/config.tsを削除しました
+  - Note: ただし、互換性のためgitignoreは維持しています
+- New: package-lock.jsonをgitignoreから削除しました
+- New: import.meta.dirnameによるパスの安全性を確保しました
+- New: /miqのエイリアスを作成しました
+- Chg: tsconfig.json:20に末尾カンマを追加し統一しました
+- Fix: earthquakeNotice.tsで条件分岐が誤っていた問題を修正しました
+- Delete: 余分な型定義を削除しました
+- Delete: tsc-aliasによるresolveFullPathsが実装されているにもかかわらず.jsを使用したimportの.jsを削除しました
+
 # 25.12.0-alpha.0
 - New: リリースノートを記録する方針を取り始めました
 - Change: tsc-aliasによるエイリアスインポートを導入しました

config/example.config.yaml

@@ -0,0 +1,57 @@
+time:
+  # 時報休止期間
+  stopTimes:
+    start: 23 # 開始
+    stop: 6 # 停止
+  
+  # 地震速報設定
+  earthquake:
+    reconnectTimes: 5000 # 再接続時間(ミリ秒)
+    websocketUrl: "wss://api.p2pquake.net/v2/ws" # WebSocketのURL
+    areasCsvUrl: "https://raw.githubusercontent.com/p2pquake/epsp-specifications/master/epsp-area.csv" # 対象地域CSVファイルのURL
+    maxScaleMin: 30 # 地震発生の際の最低震度(10-70)
+  
+  # 天気お知らせ設定
+  weather:
+    splitCount: 4 # 返信の分割数
+  
+  # Make it a quote設定
+  miq: true # 有効/無効
+
+  # 緊急時設定
+  emergency:
+    isEnabled: true # 緊急時のコンソール表示
+    mail:
+      isEnabled: true # 緊急時のメール送信
+      host: "smtp.example.com" # SMTPサーバー
+      port: 465 # SMTPポート
+      user: "mailUser@example.com" # BOTメール送信元
+      password: "mailPassword" # SMTPパスワード
+      secure: false # SMTPsecure設定
+      to: "admin@noticeuwuzu.example.com" # 緊急時メール送信先(配列可)
+    
+  
+  # /report設定
+  report:
+    isEnabled: true # 有効/無効
+    message: "" # 報告者へのメッセージ
+  
+  # 規約等
+  legal:
+    terms: | # 利用規約
+      利用規約
+    privacy: | # プライバシーポリシー
+      プライバシーポリシー
+
+  # 管理者情報設定
+  admin:
+    name: "あどみん" # BOT管理者名
+    showMail: false # メールアドレスを公開するか(false：非公開/文字列：メールアドレス)
+    panel: # 管理パネル
+      isEnabled: true # 有効/無効
+      port: 74919 # 配信ポート
+  
+  # uwuzuサーバー設定
+  uwuzu:
+    apiToken: "TOKEN_EXAMPLE" # APIトークン
+    host: "https://uwuzu.example.com" # サーバーホスト

examples/config.ts

@@ -1,68 +0,0 @@
-import type Config from "src/types/config";
-
-// READMEの設定項目を参照
-const config: Config = {
-  // 時報設定
-  time: {
-    // 時報休止期間
-    stopTimes: {
-      start: 23, // 開始
-      stop: 6, // 停止
-    },
-  },
-  // 地震速報設定
-  earthquake: {
-    reconnectTimes: 5000, // 再接続時間(ミリ秒)
-    websocketUrl: "wss://api.p2pquake.net/v2/ws", // WebSocketのURL
-    areasCsvUrl: "https://raw.githubusercontent.com/p2pquake/epsp-specifications/master/epsp-area.csv",  // 対象地域CSVファイルのURL
-    maxScaleMin: 30, // 地震発生の際の最低震度(10-70)
-  },
-  // 天気お知らせ設定
-  weather: {
-    splitCount: 4, // 返信の分割数
-  },
-  // Make it a quote設定
-  miq: true, // 有効/無効
-
-  // 緊急時設定
-  emergency: {
-    isEnabled: true,  // 緊急時のコンソール表示
-    mail: {
-      isEnabled: true,  // 緊急時のメール送信
-      host: "smtp.example.com",  // SMTPサーバー
-      port: 465,  // SMTPポート
-      user: "mailUser@example.com",  // BOTメール送信元
-      password: "mailPassword",  // SMTPパスワード
-      secure: false,  // SMTPsecure設定
-      to: "admin@noticeuwuzu.example.com",  // 緊急時メール送信先(配列可)
-    },
-  },
-  // /report設定
-  report: {
-    isEnabled: true, // 有効/無効
-    message: "", // 報告者へのメッセージ
-  },
-  // 規約等
-  legal: {
-    terms: `
-    `, // 利用規約
-    privacy: `
-    `, // プライバシーポリシー
-  },
-  // 管理者情報設定
-  admin: {
-    name: "あどみん",  // BOT管理者名
-    showMail: false,  // メールアドレスを公開するか(false：非公開/文字列：メールアドレス)
-    panel: { // 管理パネル
-      isEnabled: true,  // 有効/無効
-      port: 74919,  // 配信ポート
-    },
-  },
-  // uwuzuサーバー設定
-  uwuzu: {
-    apiToken: "TOKEN_EXAMPLE",  // APIトークン
-    host: "https://uwuzu.example.com", // サーバーホスト
-  },
-};
-
-export default config;

package.json

@@ -44,16 +44,21 @@
     "@types/sharp": "^0.31.1",
     "@types/ws": "^8.18.1",
     "canvas": "^3.2.0",
+    "chardet": "^2.1.1",
     "child_process": "^1.0.2",
     "date-fns": "^4.1.0",
+    "esm-path": "git+https://gitea.last2014.com/last2014/esm-path.git#1.0.0",
     "express": "^5.1.0",
     "fs": "^0.0.1-security",
+    "iconv-lite": "^0.7.0",
     "node-cron": "^4.1.1",
     "nodemailer": "^7.0.4",
     "sharp": "^0.34.3",
     "tsc-alias": "^1.8.16",
     "typescript": "^5.9.2",
-    "ws": "^8.18.3"
+    "ws": "^8.18.3",
+    "yaml": "^2.8.2",
+    "zod": "^4.1.13"
   },
   "devDependencies": {
     "tsx": "^4.20.3"

src/lib/config.ts

@@ -0,0 +1,94 @@
+import * as z from "zod/v3";
+import { readFileSync } from "fs";
+import { autoDecode } from "@/lib/encode";
+import { getDirname } from "esm-path";
+import * as yaml from "yaml";
+
+const schema = z.object({
+  time: z.object({
+    stopTimes: z.object({
+      start: z.number().min(0).max(23),
+      stop: z.number().min(0).max(23),
+    }),
+  }),
+  earthquake: z.object({
+    reconnectTimes: z.number().min(0),
+    websocketUrl: z.string().url(),
+    areasCsvUrl: z.string().url(),
+    maxScaleMin: z.union([
+      z.literal(-1),
+      z.literal(10),
+      z.literal(20),
+      z.literal(30),
+      z.literal(40),
+      z.literal(45),
+      z.literal(50),
+      z.literal(55),
+      z.literal(60),
+      z.literal(70),
+    ]), // z.enum()は文字列のみ(https://github.com/colinhacks/zod/issues/338)
+  }),
+  weather: z.object({
+    splitCount: z.number().min(1),
+  }),
+  miq: z.boolean(),
+  emergency: z.union([z.object({
+    isEnabled: z.literal(true),
+    mail: z.union([z.object({
+      isEnabled: z.literal(true),
+      host: z.string(),
+      port: z.number().min(0).max(65535),
+      user: z.string(),
+      password: z.string(),
+      secure: z.boolean(),
+      to: z.union([
+        z.string(),
+        z.array(z.string())
+      ]),
+    }), z.object({
+      isEnabled: z.literal(false),
+    })]),
+  }), z.object({
+    isEnabled: z.literal(false),
+  })]),
+  report: z.union([z.object({
+    isEnabled: z.literal(true),
+    message: z.string(),
+  }), z.object({
+    isEnabled: z.literal(false),
+  })]),
+  legal: z.object({
+    terms: z.string(),
+    privacy: z.string(),
+  }),
+  admin: z.object({
+    name: z.string(),
+    showMail: z.union([
+      z.string(),
+      z.literal(false)
+    ]),
+    panel: z.union([z.object({
+      isEnabled: z.literal(true),
+      port: z.number().min(0).max(65535),
+    }), z.object({
+      isEnabled: z.literal(false),
+    })]),
+  }),
+  uwuzu: z.object({
+    apiToken: z.string(),
+    host: z.string(),
+  }),
+  debug: z.literal(true).optional(),
+});
+
+const file = readFileSync(`${import.meta.dirname}/../../config/config.yaml`);
+const text = autoDecode(file);
+const configObj = yaml.parse(text);
+const parsed = schema.safeParse(configObj);
+
+if (!parsed.success) {
+  throw new Error("Config is invalid.")
+}
+
+const config = parsed.data;
+export default config;

src/lib/encode.ts

@@ -0,0 +1,7 @@
+import { decode } from "iconv-lite";
+import { detect } from "chardet";
+
+export function autoDecode(buffer: Buffer) {
+  const encoding = detect(buffer) ?? "utf-8";
+  return decode(buffer, encoding);
+}

src/lib/mailer.ts

@@ -1,4 +1,4 @@
-import config from "../../config";
+import config from "@/lib/config";
 import * as nodemailer from "nodemailer";
 
 import type SMTPTransport from "nodemailer/lib/smtp-transport";

src/scripts/asciiart.ts

@@ -1,8 +1,8 @@
 import * as fs from "fs";
 
-const version = JSON.parse(fs.readFileSync("package.json", "utf-8")).version;
+const version = JSON.parse(fs.readFileSync(`${import.meta.dirname}/../../package.json`, "utf-8")).version;
 
 export default function asciiArt() {
-  console.log(fs.readFileSync("asciiart.txt", "utf-8"));
+  console.log(fs.readFileSync(`${import.meta.dirname}/../../asciiart.txt`, "utf-8"));
   console.log(`${version}\n`);
 }

src/scripts/checks/api.ts

@@ -1,5 +1,5 @@
 import { styleText } from "util";
-import config from "../config.js";
+import config from "@/lib/config";
 
 export default async function APICheck() {
   try {

src/scripts/checks/config.ts

@@ -2,8 +2,8 @@ import * as fs from "fs";
 import { styleText } from "util";
 
 export default function ConfigCheck() {
-  if (!fs.existsSync("config.ts")) {
+  if (!fs.existsSync(`${import.meta.dirname}/../../../config/config.yaml`)) {
-    console.log(styleText("red", "config.tsがありません"));
+    console.log(styleText("red", "config/config.yamlがありません"));
     process.exit();
   }
 }

src/scripts/checks/legal.ts

@@ -1,4 +1,4 @@
-import config from "../config.js";
+import config from "@/lib/config";
 import { styleText } from "util";
 
 export default function LegalCheck() {

src/scripts/checks/main.ts

@@ -1,10 +1,10 @@
-import PackagesIsExist from "./packagesExist.js";
+import PackagesIsExist from "@/scripts/checks/packagesExist";
-import PackagesCheck from "./packages.js";
+import PackagesCheck from "@/scripts/checks/packages";
-import ConfigCheck from "./config.js";
+import ConfigCheck from "@/scripts/checks/config";
-import APICheck from "./api.js";
+import APICheck from "@/scripts/checks/api";
-import VersionCheck from "./version.js";
+import VersionCheck from "@/scripts/checks/version";
-import LegalCheck from "./legal.js";
+import LegalCheck from "@/scripts/checks/legal";
-import config from "../config.js";
+import config from "@/lib/config";
 
 export default async function Check() {
   PackagesIsExist();

src/scripts/checks/packages.ts

@@ -3,13 +3,13 @@ import { styleText } from "util";
 
 export default function PackagesCheck() {
   try {
-    if (!fs.existsSync("package.json")) {
+    if (!fs.existsSync(`${import.meta.dirname}/../../../package.json`)) {
       console.log(styleText("red", "package.jsonがありません。正規のリポジトリでgit pullを実行してください。"));
       process.exit();
     }
 
     // package.json取得
-    const packages = JSON.parse(fs.readFileSync("package.json", "utf-8"));
+    const packages = JSON.parse(fs.readFileSync(`${import.meta.dirname}/../../../package.json`, "utf-8"));
     const dependencies = packages.dependencies;
 
     const packageNames: Array<string> = [];
@@ -31,7 +31,7 @@ export default function PackagesCheck() {
     const mismatchPackages: Array<string> = [];
 
     packageNames.forEach((packageName) => {
-      const packagePath = `node_modules/${packageName}/package.json`;
+      const packagePath = `${import.meta.dirname}/../../../node_modules/${packageName}/package.json`;
 
       if (fs.existsSync(packagePath)) {
         const modulePackage = JSON.parse(fs.readFileSync(packagePath, "utf-8"));

src/scripts/checks/packagesExist.ts

@@ -3,7 +3,7 @@ import { styleText } from "util";
 
 export default function PackagesIsExist() {
   try {
-    if (!fs.existsSync("node_modules/.package-lock.json")) {
+    if (!fs.existsSync(`${import.meta.dirname}/../../../node_modules/.package-lock.json`)) {
       console.log(styleText("red", `
       node_modules/.package-lock.jsonがありません。
       プロジェクト直下でnpm installを実行してください。

src/scripts/checks/version.ts

@@ -1,25 +1,25 @@
-import config from "../config.js";
+import config from "@/lib/config";
 import { readFileSync, writeFileSync, existsSync } from "fs";
 
 export default async function VersionCheck() {
-  const packageJson = JSON.parse(readFileSync("package.json", "utf-8"));
+  const packageJson = JSON.parse(readFileSync(`${import.meta.dirname}/../../../package.json`, "utf-8"));
 
   // 初期化
-  if (!existsSync("logs/version.txt")) {
+  if (!existsSync(`${import.meta.dirname}/../../../logs/version.txt`)) {
     writeFileSync(
-      "logs/version.txt",
+      `${import.meta.dirname}/../../../logs/version.txt`,
       packageJson.version,
       "utf-8",
     );
   }
 
   // 最終起動バージョン取得
-  const oldVersion = readFileSync("logs/version.txt", "utf-8");
+  const oldVersion = readFileSync(`${import.meta.dirname}/../../../logs/version.txt`, "utf-8");
 
   if (oldVersion !== packageJson.version) {
     try {
       writeFileSync(
-        "logs/version.txt",
+        `${import.meta.dirname}/../../../logs/version.txt`,
         packageJson.version,
         "utf-8",
       );

src/scripts/clean/logsDel.ts

@@ -4,8 +4,8 @@ export default function logsDelete() {
   console.log("ログを削除中します");
 
   try {
-    unlinkSync("logs/boot.json");
+    unlinkSync(`${import.meta.dirname}/../../../logs/boot.json`);
-    unlinkSync("logs/version.txt");
+    unlinkSync(`${import.meta.dirname}/../../../logs/version.txt`);
 
     console.log("ログファイルを削除しました");
     console.log("----------------");

src/scripts/clean/packageLockDel.ts

@@ -4,7 +4,7 @@ export default function packageLockJsonDelete() {
   console.log("package-lock.jsonを削除します");
 
   try {
-    unlinkSync("package-lock.json");
+    unlinkSync(`${import.meta.dirname}/../../../package-lock.json`);
 
     console.log("package-lock.jsonを削除しました");
     console.log("----------------");

src/scripts/commands/delete.ts

@@ -1,5 +1,5 @@
 import { meApi, ueuse } from "@/types/types";
-import config from "../../../config";
+import config from "@/lib/config";
 import { Reply } from "@/scripts/commands/main";
 
 export default async function Delete(data: ueuse) {

src/scripts/commands/follow.ts

@@ -1,5 +1,5 @@
 import { ueuse } from "@/types/types";
-import config from "../../../config";
+import config from "@/lib/config";
 import { Reply } from "@/scripts/commands/main";
 
 export default async function Follow(data: ueuse) {

src/scripts/commands/info.ts

@@ -1,5 +1,5 @@
 import { ueuse } from "@/types/types";
-import config from "../../../config";
+import config from "@/lib/config";
 
 export default async function Info(data: ueuse) {
   const packageJson = JSON.parse((await import("fs")).readFileSync("package.json", "utf-8"));

src/scripts/commands/legal/privacy.ts

@@ -2,7 +2,7 @@ import { ueuse } from "@/types/types";
 
 export default async function PrivacyPolicy(data: ueuse) {
   (await import("@/scripts/commands/main")).Reply(
-    (await import("../../../../config")).default.legal.privacy,
+    (await import("@/lib/config")).default.legal.privacy,
     data.uniqid
   );
 }

src/scripts/commands/legal/terms.ts

@@ -2,7 +2,7 @@ import { ueuse } from "@/types/types";
 
 export default async function Terms(data: ueuse) {
   (await import("@/scripts/commands/main")).Reply(
-    (await import("../../../../config")).default.legal.terms,
+    (await import("@/lib/config")).default.legal.terms,
     data.uniqid
   );
 }

src/scripts/commands/main.ts

@@ -1,5 +1,5 @@
 import * as fs from "fs";
-import config from "../../../config";
+import config from "@/lib/config";
 import type { ueuse } from "@/types/types";
 
 // 初期化

src/scripts/commands/miq/allow.ts

@@ -1,8 +1,8 @@
 import { meApi, ueuse } from "@/types/types";
-import config from "../../../../config";
+import config from "@/lib/config";
 import { Reply } from "@/scripts/commands/main";
 import { Permission } from "@/scripts/commands/miq/permission";
-import MiQ from "../../../../miq/main";
+import MiQ from "miq/main";
 
 export default async function MiQAllow(data: ueuse) {
   if (!config.miq) {

src/scripts/commands/miq/main.ts

@@ -1,5 +1,5 @@
 import { ueuse } from "@/types/types";
-import config from "../../../../config";
+import config from "@/lib/config";
 import { Reply } from "@/scripts/commands/main";
 import type { Permission } from "@/scripts/commands/miq/permission";
 

src/scripts/commands/report.ts

@@ -1,6 +1,6 @@
 import { ueuse } from "@/types/types";
-import { Reply } from "./main";
+import { Reply } from "@/scripts/commands/main";
-import config from "../../../config";
+import config from "@/lib/config";
 
 export default async function Report(data: ueuse) {
   if (

src/scripts/commands/unfollow.ts

@@ -1,6 +1,6 @@
 import { ueuse } from "@/types/types";
-import config from "../../../config";
+import config from "@/lib/config";
-import { Reply } from "./main";
+import { Reply } from "@/scripts/commands/main";
 
 export default async function UnFollow(data: ueuse) {
   const unfollowReq = await fetch(`${config.uwuzu.host}/api/users/unfollow`, {

src/scripts/commands/weather.ts

@@ -1,5 +1,5 @@
 import { weatherReply } from "@/scripts/weatherNotice";
-import { ueuse } from "@/types/types.js";
+import { ueuse } from "@/types/types";
 
 export default function Weather(data: ueuse) {
   weatherReply(data.uniqid);

src/scripts/earthquakeNotice.ts

@@ -1,6 +1,6 @@
 import WebSocket from "ws";
 import sendMail from "@/lib/mailer";
-import config from "../../config.js";
+import config from "@/lib/config";
 
 class P2PEarthquakeClient {
   private ws: WebSocket | null = null;
@@ -283,7 +283,7 @@ async function event(earthquakeInfo: any): Promise<void> {
       console.log("サーバーがダウンする可能性があります");
 
       // メール送信
-      if (config.emergency.isEnabled) {
+      if (config.emergency.mail.isEnabled) {
         sendMail({
           to: config.emergency.mail.to,
           subject: "【警告】震度6強以上の地震を受信しました",

src/scripts/eventday.ts

@@ -1,6 +1,6 @@
 import { format } from "date-fns";
 import eventdays from "@/constants/eventday";
-import config from "../../config";
+import config from "@/lib/config";
 
 export default async function EventDays() {
   const now = format(new Date(), "MM/dd");

src/scripts/successExit.ts

@@ -1,6 +1,6 @@
 import * as fs from "fs";
 import { isAfter } from "date-fns";
-import config from "../../config";
+import config from "@/lib/config";
 import sendMail from "@/lib/mailer";
 
 export default function successExit() {

src/scripts/timeNotice.ts

@@ -1,6 +1,6 @@
 import { format } from "date-fns";
 import type * as types from "@/types/types";
-import config from "../../config";
+import config from "@/lib/config";
 
 export default async function timeNotice() {
   // 停止時間

src/scripts/weatherNotice.ts

@@ -1,6 +1,6 @@
 import { cityList } from "@/constants/weather";
 import type * as types from "@/types/types";
-import config from "../../config";
+import config from "@/lib/config";
 
 export async function weatherNotice() {
   console.log("----------------");

src/types/config.d.ts

@@ -28,7 +28,6 @@ export default interface Config {
       to: string | string[];
     } | {
       isEnabled: false;
-      mail: undefined;
     };
   } | {
     isEnabled: false;

tsconfig.json

@@ -16,8 +16,9 @@
     ],
     "paths": {
       "@/*": ["./src/*"],
+      "miq": ["./miq/*"],
       "ws": ["./node_modules/ws/index.js"],
-      "@types/ws": ["./node_modules/@types/ws/index.d.ts"]
+      "@types/ws": ["./node_modules/@types/ws/index.d.ts"],
     },
     "removeComments": true,
   },