@kira905/dsh-butler-install 0.1.0 → 0.2.0

package/lib/run.mjs

@@ -8,19 +8,14 @@
  *     不看"我以为它装过了"。
  *  3. 退出码只有三档有意义：0 全绿 / 3 失败但回滚干净 / 4 失败且回滚不干净。
  */
-import fs from 'node:fs';
 import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { loadManifest, formatManifestError, describeItem } from './manifest.mjs';
-import { satisfies, parseRange, describeRange } from './semver.mjs';
+import { describeItem } from './manifest.mjs';
+import { satisfies } from './semver.mjs';
 import {
-  resolveHome,
   readProfile,
   profileInstalledVersion,
   globalInstalledVersion,
-  resolveNpmPrefix,
   findExistingBin,
-  findOnPath,
   readInstalledDshDecl,
 } from './state.mjs';
 import { runProbe } from './probe.mjs';
@@ -28,16 +23,19 @@ import { analyzeDump, checkMounted, skippedBundlesFromStderr } from './dump.mjs'
 import { takeSnapshot, restoreSnapshot, verifySnapshotRestored, SNAPSHOT_WARNING } from './snapshot.mjs';
 import { spawnCommand, formatCommandLine } from './exec.mjs';
 import { EXIT } from './cli-args.mjs';
-
-export { EXIT };
-
-const PKG_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
-export const DEFAULT_MANIFEST = path.join(PKG_ROOT, 'suite-manifest.json');
-
-function shortName(name) {
-  const parts = String(name).split('/');
-  return parts[parts.length - 1];
-}
+import {
+  DEFAULT_MANIFEST,
+  selectItems,
+  installStepFor,
+  uninstallStepFor,
+  assessItem,
+  criteriaText,
+  buildSuiteState,
+} from './plan.mjs';
+
+// 「清单 → 选中 → 现状 → 每项要跑的命令」这一层搬去了 lib/plan.mjs（--ui 的 GET /state 与这里同源）。
+// 这几个名字老早就在本文件里导出过，夹具也在用，所以在这儿原样再导出，别改 import 路径。
+export { EXIT, DEFAULT_MANIFEST, selectItems, installStepFor, uninstallStepFor, assessItem, criteriaText };
 
 function firstLine(text) {
   return String(text || '').trim().split(/\r?\n/)[0] || '';
@@ -47,60 +45,6 @@ function stamp() {
   return new Date().toISOString().replace(/[-:]/g, '').replace(/\..*$/, '');
 }
 
-/** 按 --only / --skip 选条目；组名、包名、短名、别名都认 */
-export function selectItems(manifest, { only = [], skip = [] } = {}) {
-  const items = manifest.items;
-  const errors = [];
-  const groups = [...new Set(items.map((i) => i.group))];
-  const resolve = (token) => items.filter((i) => (
-    i.name === token
-    || shortName(i.name) === token
-    || i.group === token
-    || (Array.isArray(i.aliases) && i.aliases.includes(token))
-  ));
-
-  let selected = items.slice();
-  if (only.length) {
-    const picked = new Set();
-    for (const token of only) {
-      const hits = resolve(token);
-      if (!hits.length) {
-        errors.push(`--only 里的 ${JSON.stringify(token)} 没匹配到任何条目（可选组：${groups.join(' / ')}；也可以直接写包名或别名）`);
-        continue;
-      }
-      for (const h of hits) picked.add(h.name);
-    }
-    selected = items.filter((i) => picked.has(i.name));
-  }
-
-  const dropped = new Set();
-  for (const token of skip) {
-    const hits = resolve(token);
-    if (!hits.length) errors.push(`--skip 里的 ${JSON.stringify(token)} 没匹配到任何条目`);
-    for (const h of hits) dropped.add(h.name);
-  }
-
-  return { items: selected.filter((i) => !dropped.has(i.name)), errors, groups };
-}
-
-export function installStepFor(item, { profile, npmPrefix }) {
-  // 装的时候把**清单里的期望区间**一起点名（`<包>@^x.y.z`）。
-  // 为什么必须带上：不带区间时拿到的是注册表 `latest` 标签指的那个版本，而它未必在
-  // 我们期望的区间里（实测踩过：latest 标签指着的版本与最高版本号不是一回事）。
-  // 带区间 = 让解析器只能落进期望区间，落不进去就报错，而不是"装了个别的版本还报成功"。
-  const spec = `${item.name}@${item.versionRange}`;
-  if (item.type === 'plugin') {
-    return { file: 'dsh', args: ['plugin', '--profile', profile, 'add', spec], env: {} };
-  }
-  return { file: 'npm', args: ['i', '-g', spec], env: npmPrefix ? { npm_config_prefix: npmPrefix } : {} };
-}
-
-export function uninstallStepFor(item, { profile, npmPrefix }) {
-  if (item.type === 'plugin') {
-    return { file: 'dsh', args: ['plugin', '--profile', profile, 'remove', item.name], env: {} };
-  }
-  return { file: 'npm', args: ['rm', '-g', item.name], env: npmPrefix ? { npm_config_prefix: npmPrefix } : {} };
-}
 
 function execEnv(ctx, extra) {
   return { DSH_HOME: ctx.home, ...(extra || {}) };
@@ -150,49 +94,6 @@ async function getDumpAnalysis(ctx) {
   return dumpCache;
 }
 
-/** 判定某一项"现在是否已满足"，纯读文件 */
-export function assessItem(item, ctx, profile, { upgrade = false } = {}) {
-  const mount = item.mount || (item.type === 'plugin' ? 'auto' : 'none');
-  if (item.type === 'plugin') {
-    const version = profileInstalledVersion(ctx.home, ctx.profile, item.name);
-    const depDeclared = Object.prototype.hasOwnProperty.call(profile.deps || {}, item.name);
-    const bundleRegistered = (profile.bundles || []).includes(item.name);
-    const range = version ? satisfies(item.versionRange, version) : 'no';
-    const decl = readInstalledDshDecl(ctx.home, ctx.profile, item.name);
-    // 该不该进组合列表：**以包实体的声明为准**。本版没声明 bundle 的包，
-    // 不登记也是正确状态（登记反而是空的），所以这里不拿"没登记"判它未满足。
-    const mountOk = mount !== 'auto' || bundleRegistered || !decl.hasBundle;
-    const satisfied = Boolean(version) && depDeclared && mountOk && (range === 'yes' || range === 'unknown');
-    return {
-      item,
-      type: 'plugin',
-      mount,
-      version,
-      depDeclared,
-      bundleRegistered,
-      range,
-      satisfied,
-      action: satisfied && !upgrade ? 'skip' : 'install',
-    };
-  }
-  const version = globalInstalledVersion(ctx.npmPrefix, item.name);
-  const binFile = item.probe && item.probe.cmd
-    ? findExistingBin({ cmd: item.probe.cmd, home: ctx.home, profile: ctx.profile, npmPrefix: ctx.npmPrefix })
-    : null;
-  const range = version ? satisfies(item.versionRange, version) : 'no';
-  const satisfied = Boolean(version) && Boolean(binFile) && (range === 'yes' || range === 'unknown');
-  return {
-    item,
-    type: 'cli',
-    mount: 'none',
-    version,
-    binFile,
-    range,
-    satisfied,
-    action: satisfied && !upgrade ? 'skip' : 'install',
-  };
-}
-
 function rangeStatus(range, version) {
   if (!version) return { status: 'fail', detail: '未安装' };
   if (range === 'yes') return { status: 'pass', detail: `实体 ${version}，落在期望区间内` };
@@ -269,96 +170,28 @@ export async function runSuite(options) {
     const stream = options.json ? process.stderr : process.stdout;
     stream.write(`${text}\n`);
   };
-  const summary = {
-    mode: options.uninstall ? 'uninstall' : options.apply ? 'apply' : 'dry-run',
-    profile: options.profile,
-    home: null,
-    npmPrefix: null,
-    manifest: null,
-    items: [],
-    warnings: [],
-    excluded: [],
-    rollback: null,
-    exitCode: null,
-  };
+  // 清单 → 选中 → 现状 → 每项要跑的命令：全部在 lib/plan.mjs 里算一次。
+  // 这里只负责"印人话"；`--ui` 的 GET /state 是同一份数据的另一种渲染 —— 两处必然一致。
+  const built = await buildSuiteState(options);
+  for (const line of built.log) say(line);
+
+  const summary = built.summary;
   const warn = (text) => {
     summary.warnings.push(text);
     say(`⚠ ${text}`);
   };
 
-  // ── 1. 清单 ────────────────────────────────────────────────
-  const manifestPath = options.manifest || DEFAULT_MANIFEST;
-  let manifest;
-  try {
-    manifest = loadManifest(manifestPath);
-  } catch (err) {
-    say(formatManifestError(err, path.basename(manifestPath)));
-    summary.exitCode = EXIT.USAGE;
-    return { exitCode: EXIT.USAGE, summary, text: lines.join('\n') };
-  }
-  summary.manifest = manifest.path;
-  summary.excluded = manifest.excluded.map((e) => ({ id: e.id, reason: e.reason }));
-
-  // ── 2. 选条目 ──────────────────────────────────────────────
-  const selection = selectItems(manifest, options);
-  if (selection.errors.length) {
-    for (const e of selection.errors) say(`✖ ${e}`);
-    summary.exitCode = EXIT.USAGE;
-    return { exitCode: EXIT.USAGE, summary, text: lines.join('\n') };
-  }
-  if (!selection.items.length) {
-    say('✖ 选完之后没有任何条目可做（检查 --only / --skip）');
-    summary.exitCode = EXIT.USAGE;
-    return { exitCode: EXIT.USAGE, summary, text: lines.join('\n') };
-  }
-
-  // ── 3. 上下文 ──────────────────────────────────────────────
-  const home = resolveHome(options.home);
-  const profile = readProfile(home, options.profile);
-  const npm = await resolveNpmPrefix(options.npmPrefix);
-  const ctx = { home, profile: options.profile, npmPrefix: npm.prefix };
-  summary.home = home;
-  summary.npmPrefix = npm.prefix;
-
-  say(`清单：${manifest.path}`);
-  say(`共 ${manifest.items.length} 项，本次选中 ${selection.items.length} 项（组：${[...new Set(selection.items.map((i) => i.group))].join(' / ')}）`);
-  say(`数据根：${home}`);
-  say(`profile：${options.profile}（${profile.exists ? '已存在' : '尚不存在，真装时由宿主自动创建'}）`);
-  say(`全局包落点：${npm.prefix}（来源：${npm.source}）`);
-  if (manifest.excluded.length) {
-    for (const entry of manifest.excluded) {
-      say(`⏭ 不可安装项 ${entry.id}：${entry.reason}`);
-    }
+  if (!built.ok) {
+    summary.exitCode = built.exitCode;
+    return { exitCode: built.exitCode, summary, text: lines.join('\n') };
   }
-  say('');
 
-  // 前置：dsh 与 npm 两条原语都得在
-  const dshPath = findOnPath('dsh') || findExistingBin({ cmd: 'dsh', home, profile: options.profile, npmPrefix: npm.prefix });
-  const npmPath = findOnPath('npm');
-  const preflight = [];
-  if (!dshPath) preflight.push('找不到 dsh 命令（PATH 与全局前缀两处都查过）⇒ 插件类无从安装，也无法核对挂载');
-  if (!npmPath) preflight.push('找不到 npm 命令 ⇒ 命令行类无从安装');
-
-  // ── 4. 计划 ────────────────────────────────────────────────
-  const plan = selection.items.map((item) => assessItem(item, ctx, profile, { upgrade: options.upgrade }));
-  summary.items = plan.map((p) => ({
-    name: p.item.name,
-    type: p.item.type,
-    group: p.item.group,
-    mount: p.mount,
-    installedVersion: p.version,
-    inRange: p.range,
-    satisfied: p.satisfied,
-    action: p.action,
-  }));
-
-  const toInstall = plan.filter((p) => p.action === 'install');
-  const skipped = plan.filter((p) => p.action === 'skip');
-
-  if (!options.uninstall) {
-    say(`建议顺序（组件之间没有代码依赖，"顺序"只是排查建议）：先装面板 → 界面增强 → 记忆 → 命令行工具一批。`);
-    say('');
-  }
+  const { plan, preflight } = built;
+  const { toInstall, skipped } = built;
+  const ctx = built.ctx;
+  const home = built.ctx.home;
+  const profile = built.profile;
+  const npm = built.npm;
 
   // ── 5a. 演练：一条命令都不跑 ───────────────────────────────
   if (!options.apply) {
@@ -372,12 +205,10 @@ export async function runSuite(options) {
       if (entry.action === 'skip') {
         say('  动作：跳过（已满足）');
       } else {
-        const step = options.uninstall
-          ? uninstallStepFor(entry.item, { profile: options.profile, npmPrefix: npm.prefix })
-          : installStepFor(entry.item, { profile: options.profile, npmPrefix: npm.prefix });
+        // 命令与判据都是 lib/plan.mjs 生成那一份，这里只印，绝不另拼一遍
         say(`  动作：${options.uninstall ? '卸载' : '安装'}`);
-        say(`  命令：${formatCommandLine(step.file, step.args)}`);
-        say(`  判据：${criteriaText(entry.item)}`);
+        say(`  命令：${options.uninstall ? entry.commandUninstall : entry.command}`);
+        say(`  判据：${entry.criteria}`);
       }
       say('');
     });
@@ -626,28 +457,6 @@ export async function runSuite(options) {
   return { exitCode: summary.exitCode, summary, text: lines.join('\n') };
 }
 
-function criteriaText(item) {
-  const parts = [];
-  const kind = (item.probe && item.probe.kind) || 'existence';
-  if (kind === 'existence') {
-    parts.push(item.type === 'plugin'
-      ? `profile 的 node_modules/${item.name}/package.json 存在（只查文件，不执行）`
-      : `命令文件 ${item.probe.cmd} 在 .bin 或全局前缀下存在（只查文件，不执行）`);
-  } else if (kind === 'help') {
-    parts.push(`先静态核 ${item.probe.cmd} 源码里确有 --help 分支，再跑 ${item.probe.cmd} --help`);
-  } else {
-    parts.push(`跑 ${item.probe.cmd} ${(item.probe.argv || []).join(' ')}（清单声明只读：${item.probe.readonlyBecause}）`);
-  }
-  parts.push(`实体版本落在 ${describeRange(parseRange(item.versionRange))}`);
-  if (item.type === 'plugin' && (item.mount || 'auto') === 'auto') {
-    parts.push('dump-config 里组合头恰好 1 行、条目 name 恰好 1 条、该 id 在整棵树里恰好 1 次');
-  }
-  if (item.type === 'plugin' && item.mount === 'manual') {
-    parts.push('挂载不判（本包按设计不进组合列表）');
-  }
-  return parts.join(' · ');
-}
-
 function printSummary(say, plan, failure) {
   say('');
   say('== 汇总 ==');