@sfmc-bds/cli 0.2.0-beta.9 → 0.2.0

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@sfmc-bds/cli",
-  "version": "0.2.0-beta.9",
+  "version": "0.2.0",
   "description": "SFMC management CLI — REPL, service supervisor, module install, behavior-pack build/deploy",
   "author": "Shiroha7z",
-  "license": "AGPL-v3.0-only",
+  "license": "AGPL-3.0-only",
   "type": "module",
   "homepage": "https://github.com/DogeLakeDev/ScriptsForMinecraftServer/tree/main/packages/cli#readme",
   "repository": {
@@ -35,30 +35,37 @@
       "types": "./dist/main.d.ts",
       "import": "./dist/main.js",
       "default": "./dist/main.js"
-    }
+    },
+    "./fetch-module.mjs": "./scripts/module-install/fetch-module.mjs",
+    "./package.json": "./package.json"
   },
   "bin": {
-    "sfmc": "./dist/main.js"
+    "sfmc": "./dist/main.js",
+    "sfmc-fetch-module": "./scripts/module-install/fetch-module.mjs"
   },
   "files": [
     "dist",
+    "scripts",
     "README.md"
   ],
-  "scripts": {
-    "build": "sfmc-esbuild-transpile --dts",
-    "prepublishOnly": "npm run build",
-    "start": "node ./dist/main.js",
-    "test": "npm run build && node --test terminal-progress.test.mjs wrap-log-line.test.mjs world-packs-uninstall.test.mjs log-filter.test.mjs debug-command.test.mjs command-surface.test.mjs argv-parse.test.mjs command-palette.test.mjs repl-windows.test.mjs module-toggle.test.mjs llbot-launch.test.mjs",
-    "typecheck": "tsc7 --noEmit -p tsconfig.json"
-  },
   "dependencies": {
     "@clack/prompts": "^1.7.0",
-    "@sfmc-bds/bds-tools": "^0.2.0-beta.9",
-    "@sfmc-bds/sdk": "^0.2.0-beta.9",
-    "chalk": "^6.0.0"
+    "chalk": "^6.0.0",
+    "cross-spawn": "7.0.6",
+    "esbuild": "^0.28.1",
+    "@sfmc-bds/bds-tools": "0.2.0",
+    "@sfmc-bds/sdk": "0.2.0"
+  },
+  "devDependencies": {
+    "@sfmc-bds/tools": "0.2.0"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "sfmc-esbuild-transpile --dts",
+    "start": "node ./dist/main.js",
+    "typecheck": "tsc7 --noEmit -p tsconfig.json"
   }
-}
+}

package/scripts/module-install/check-modules.mjs

@@ -0,0 +1,178 @@
+#!/usr/bin/env node
+// @ts-check
+/**
+ * @sfmc-bds/cli — 离线校验 catalog 与已安装模块包的全局一致性
+ *
+ * 职责分工边界：
+ * - 全局目录一致性：本文件专注于校验 catalog 唯一性（id / configKey）、requires 依赖闭包、以及 catalog.id 与 manifest.id 的严格对齐；
+ * - 字段形状校验解耦：模块 manifest 的具体字段结构、版本判定与必填规则完全委托给 SDK 的权威总入口 `validateManifest`，不再在本地重复实现字段形状检查。
+ *
+ * 用法：
+ *   node packages/cli/scripts/module-install/check-modules.mjs
+ *   node …/check-modules.mjs --sync   # 先 sync catalog 再执行校验
+ */
+import { validateManifest } from "@sfmc-bds/sdk/module-loader";
+import fs from "node:fs";
+import path from "node:path";
+import process from "node:process";
+import { fileURLToPath } from "node:url";
+import { readCatalog, syncCatalogFromPackages } from "./lib/catalog.mjs";
+import { exists } from "./lib/io.mjs";
+import { folderFromEntryPath, scanInstalledPackages } from "./lib/packages.mjs";
+import { ROOT } from "./lib/paths.mjs";
+
+/**
+ * @typedef {object} CheckModulesOpts
+ * @property {boolean} [sync]
+ */
+
+/**
+ * @typedef {object} CheckModulesResult
+ * @property {boolean} ok
+ * @property {string} [error]
+ * @property {string} [summary]
+ * @property {string[]} [warnings]
+ */
+
+/**
+ * @param {string} moduleRoot
+ * @param {string} configKey
+ * @returns {{ ok: true; warning?: string } | { ok: false; error: string }}
+ */
+export function validateDefaultConfig(moduleRoot, configKey) {
+  const defaultsDir = path.join(moduleRoot, "configs-default");
+  const expected = path.join(defaultsDir, `${configKey}.json`);
+  if (!exists(expected)) {
+    const jsonFiles = exists(defaultsDir)
+      ? fs.readdirSync(defaultsDir).filter((name) => name.toLowerCase().endsWith(".json"))
+      : [];
+    if (jsonFiles.length > 0) {
+      return {
+        ok: false,
+        error: `默认配置文件名必须为 configs-default/${configKey}.json，实际为 ${jsonFiles.join(", ")}`,
+      };
+    }
+    return { ok: true, warning: `未提供默认配置 configs-default/${configKey}.json` };
+  }
+  try {
+    const parsed = JSON.parse(fs.readFileSync(expected, "utf8"));
+    if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) {
+      return { ok: false, error: `默认配置 configs-default/${configKey}.json 顶层必须是 JSON 对象` };
+    }
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    return { ok: false, error: `默认配置 configs-default/${configKey}.json 解析失败: ${message}` };
+  }
+  return { ok: true };
+}
+
+/**
+ * @param {CheckModulesOpts} [opts]
+ * @returns {CheckModulesResult}
+ */
+export function runCheckModules(opts = {}) {
+  const doSync = opts.sync ?? false;
+  /** @type {string[]} */
+  const warnings = [];
+
+  try {
+    if (doSync) {
+      syncCatalogFromPackages();
+    }
+
+    const catalog = readCatalog();
+    const modules = catalog.modules;
+
+    if (modules.length === 0) {
+      const pkgs = scanInstalledPackages();
+      if (pkgs.length > 0) {
+        return {
+          ok: false,
+          error: `catalog 为空但 packages/ 有 ${pkgs.length} 个已装包 — 运行 catalog-sync 或 fetch-module install`,
+        };
+      }
+      return { ok: true, summary: "check-modules OK (空 catalog，无已装包)" };
+    }
+
+    const ids = new Set();
+    const keys = new Set();
+
+    for (const m of modules) {
+      if (!m.id || typeof m.id !== "string") return { ok: false, error: "条目缺少 id" };
+      if (!m.configKey || typeof m.configKey !== "string") return { ok: false, error: `${m.id}: 缺少 configKey` };
+      if (ids.has(m.id)) return { ok: false, error: `重复 id: ${m.id}` };
+      if (keys.has(m.configKey)) return { ok: false, error: `重复 configKey: ${m.configKey}` };
+      ids.add(m.id);
+      keys.add(m.configKey);
+
+      if (!m.entry || !m.entry.path) return { ok: false, error: `${m.id}: 缺少 entry.path` };
+      const abs = path.join(ROOT, m.entry.path);
+      if (!exists(abs)) return { ok: false, error: `${m.id}: entry 不存在: ${m.entry.path}` };
+
+      const folder = folderFromEntryPath(m.entry.path);
+      if (!folder) return { ok: false, error: `${m.id}: 无法从 entry.path 解析 packages 目录` };
+
+      const manifestPath = path.join(ROOT, "modules", "packages", folder, "sapi", "manifest.json");
+      if (!exists(manifestPath)) return { ok: false, error: `${m.id}: 缺少 manifest.json` };
+
+      let manifest;
+      try {
+        manifest = JSON.parse(fs.readFileSync(manifestPath, "utf8"));
+      } catch (e) {
+        const message = e instanceof Error ? e.message : String(e);
+        return { ok: false, error: `${m.id}: manifest 解析失败: ${message}` };
+      }
+
+      // 单个 manifest 字段形状校验：委托 SDK validateManifest 权威入口，本脚本不重复实现字段检查
+      const v = validateManifest(manifest);
+      if (!v.ok) {
+        return { ok: false, error: `${m.id}: manifest 校验未通过 — ${v.errors.join("; ")}` };
+      }
+      // 校验 catalog 条目与 manifest 实际声明的模块身份（id）严格一致
+      if (manifest.id !== m.id) {
+        return { ok: false, error: `${m.id}: catalog.id 与 manifest.id(${manifest.id}) 不一致` };
+      }
+      const defaultConfig = validateDefaultConfig(path.dirname(path.dirname(manifestPath)), manifest.configKey);
+      if (!defaultConfig.ok) return { ok: false, error: `${m.id}: ${defaultConfig.error}` };
+      if (defaultConfig.warning) warnings.push(`${m.id}: ${defaultConfig.warning}`);
+    }
+
+    for (const m of modules) {
+      const reqs = Array.isArray(m.requires) ? m.requires : [];
+      for (const dep of reqs) {
+        if (!ids.has(dep)) return { ok: false, error: `${m.id}: requires "${dep}" 不在 catalog 中` };
+      }
+    }
+
+    for (const pkg of scanInstalledPackages()) {
+      if (!ids.has(pkg.manifest.id)) {
+        console.warn(
+          `[check-modules] WARN: packages/${pkg.folder} (${pkg.manifest.id}) 未入 catalog — 运行 catalog-sync`
+        );
+      }
+    }
+
+    return { ok: true, summary: `check-modules OK (${modules.length} modules)`, warnings };
+  } catch (e) {
+    const message = e instanceof Error ? e.message : String(e);
+    return { ok: false, error: message };
+  }
+}
+
+function main() {
+  const doSync = process.argv.includes("--sync");
+  const result = runCheckModules({ sync: doSync });
+  if (!result.ok) {
+    console.error(`[check-modules] FAIL: ${result.error}`);
+    process.exit(1);
+  }
+  for (const warning of result.warnings ?? []) {
+    console.warn(`[check-modules] WARN: ${warning}`);
+  }
+  console.log(`[check-modules] ${result.summary}`);
+}
+
+const __checkModulesMain = fileURLToPath(import.meta.url);
+if (process.argv[1] && path.resolve(process.argv[1]) === path.resolve(__checkModulesMain)) {
+  main();
+}