opencode-rules-md 0.8.4 → 0.8.6

package/src/cli/status.ts

@@ -0,0 +1,293 @@
+// ---------------------------------------------------------------------------
+// src/cli/status.ts — `omd status` and `omd doctor` command implementations.
+//
+// Three correctness fixes vs. the previous implementation:
+//
+//   1. We read `data['plugin']` (singular) as the source of truth, with a
+//      backward-compat fallback to `data['plugins']`. The legacy plural
+//      field is no longer authoritative.
+//   2. `runDoctor` warns when a legacy `plugins` field is present, so users
+//      upgrading from the buggy version are nudged to clean up.
+//   3. The cache freshness check uses ~/.cache/opencode/packages/ (where
+//      OpenCode actually stores plugin installs) instead of the legacy
+//      ~/.cache/opencode/node_modules/ path.
+// ---------------------------------------------------------------------------
+
+import { join, dirname, extname } from 'path';
+import { homedir } from 'os';
+import {
+  loadGlobalConfig,
+  matchesPlugin,
+  readInstalledPlugins,
+  type CliFs,
+  type LoadedConfig,
+} from './config.js';
+import { fetchLatestVersion } from './registry.js';
+import { resolveCachePaths } from './update.js';
+
+// ─── Status types ─────────────────────────────────────────────────────────────
+
+export interface StatusOptions {
+  /** Override latest version for testing — skips the npm registry call */
+  latestVersion?: string | null;
+}
+
+export interface StatusEntry {
+  basename: string;
+  path: string;
+  format: string;
+  installed: string | null;
+  notInstalled?: boolean;
+  otherPlugins: string[];
+  latest: string | null;
+  isLatest: boolean | null;
+}
+
+export interface StatusResult {
+  configs: StatusEntry[];
+}
+
+// ─── Doctor types ─────────────────────────────────────────────────────────────
+
+export interface DoctorOptions {
+  nodeVersion?: string;
+  hasBun?: boolean;
+  ruleDirExists?: boolean;
+}
+
+export interface DoctorResult {
+  ok: boolean;
+  issues: string[];
+  warnings: string[];
+  info: string[];
+}
+
+// ─── Constants ───────────────────────────────────────────────────────────────
+
+const RULE_DIR_NAME = 'opencode-rules-md';
+const MIN_NODE_VERSION = 20;
+
+const CONFIG_BASENAMES = ['opencode', 'tui'] as const;
+
+// ─── runStatus ────────────────────────────────────────────────────────────────
+
+/**
+ * Run the status command: read-only probe for both opencode.json and tui.json.
+ * Reports path, format, installed specifier, other plugins, and freshness.
+ */
+export const runStatus = async (
+  fs: CliFs,
+  env: NodeJS.ProcessEnv,
+  log: (s: string) => void,
+  opts: StatusOptions = {},
+): Promise<StatusResult> => {
+  const configs: StatusEntry[] = [];
+  const latest = opts.latestVersion !== undefined
+    ? opts.latestVersion
+    : await fetchLatestVersion();
+
+  for (const basename of CONFIG_BASENAMES) {
+    const loaded = loadGlobalConfig(fs, env, basename);
+    const format = extname(loaded.path) as string; // '.json' or '.jsonc'
+    const plugins = readInstalledPlugins(loaded);
+    const match = plugins.find((p) => matchesPlugin(p)) ?? null;
+
+    const entry: StatusEntry = {
+      basename,
+      path: loaded.path,
+      format,
+      installed: match,
+      notInstalled: !loaded.exists || match === null,
+      otherPlugins: plugins.filter((p) => !matchesPlugin(p)),
+      latest,
+      isLatest:
+        match !== null && latest !== null
+          ? match === `opencode-rules-md@${latest}`
+          : null,
+    };
+
+    configs.push(entry);
+
+    if (!loaded.exists) {
+      log(`omd: ${basename}.json — config not found at ${loaded.path}`);
+      continue;
+    }
+
+    log(`omd: ${basename}${format} — ${loaded.path}`);
+    if (match) {
+      const isLatestLabel =
+        entry.isLatest === true
+          ? ' (latest)'
+          : entry.isLatest === false
+            ? ` (behind: latest is ${latest ?? 'unknown'})`
+            : '';
+      log(`  opencode-rules-md: ${match}${isLatestLabel}`);
+    } else {
+      log('  opencode-rules-md: not installed');
+    }
+
+    if (entry.otherPlugins.length > 0) {
+      log(`  other plugins: ${entry.otherPlugins.join(', ')}`);
+    }
+  }
+
+  return { configs };
+};
+
+// ─── runDoctor ────────────────────────────────────────────────────────────────
+
+/**
+ * Run the doctor command: health checks for the plugin environment.
+ *
+ * Checks:
+ *   - Node >= 20: issue if below
+ *   - Bun on PATH: issue if absent
+ *   - Both configs readable and valid: issue if absent or malformed
+ *   - Legacy `plugins` field present: warning (no-op for the runtime, but
+ *     indicates a previous buggy install)
+ *   - Rule dir existence: warning if absent
+ *   - Config dir writable: issue if not writable
+ *   - Package freshness: info line about update availability
+ *
+ * Exit 1 if any issues found.
+ */
+export const runDoctor = async (
+  fs: CliFs,
+  env: NodeJS.ProcessEnv,
+  log: (s: string) => void,
+  error: (s: string) => void,
+  opts: DoctorOptions = {},
+): Promise<DoctorResult> => {
+  const issues: string[] = [];
+  const warnings: string[] = [];
+  const info: string[] = [];
+
+  const nodeVersion = opts.nodeVersion ?? process.version.slice(1); // strip 'v'
+  const ruleDirExists = opts.ruleDirExists ?? true;
+
+  // Check if Bun is available: use override if provided, otherwise scan PATH
+  let hasBun = opts.hasBun;
+  if (hasBun === undefined) {
+    const pathEnv = (env.PATH ?? '').split(':');
+    hasBun = pathEnv.some((p) => {
+      try {
+        const { existsSync } = require('node:fs') as typeof import('node:fs');
+        return existsSync(p + '/bun');
+      } catch {
+        return false;
+      }
+    });
+  }
+
+  // ── Check: Node version ───────────────────────────────────────────────────
+  log('Checking Node version...');
+  const nodeMajor = parseInt(nodeVersion.split('.')[0] ?? '0', 10);
+  if (nodeMajor < MIN_NODE_VERSION) {
+    issues.push(`Node.js ${nodeVersion} is too old; requires Node >= ${MIN_NODE_VERSION}`);
+    error(`[ISSUE] Node.js ${nodeVersion} — requires >= ${MIN_NODE_VERSION}. Download latest from https://nodejs.org`);
+  } else {
+    log(`  Node.js ${nodeVersion} — OK`);
+  }
+
+  // ── Check: Bun on PATH ─────────────────────────────────────────────────────
+  log('Checking for Bun...');
+  if (!hasBun) {
+    issues.push('Bun is not on PATH — install from https://bun.sh');
+    error('[ISSUE] Bun not found on PATH — install Bun for best performance');
+  } else {
+    log('  Bun — found on PATH');
+  }
+
+  // ── Check: both configs readable and valid ─────────────────────────────────
+  for (const basename of CONFIG_BASENAMES) {
+    log(`Checking ${basename} config...`);
+    const loaded: LoadedConfig = loadGlobalConfig(fs, env, basename);
+
+    if (!loaded.exists) {
+      warnings.push(`${basename} config not found at ${loaded.path}`);
+      log(`  ${basename}: not found (will be created on first install)`);
+      continue;
+    }
+
+    log(`  ${basename}${extname(loaded.path)}: ${loaded.path}`);
+    const plugins = readInstalledPlugins(loaded);
+    const match = plugins.find((p) => matchesPlugin(p)) ?? null;
+
+    if (match) {
+      info.push(`${basename}: opencode-rules-md installed (${match})`);
+      log(`  opencode-rules-md: ${match}`);
+    } else {
+      warnings.push(`${basename}: plugin not installed`);
+      log('  opencode-rules-md: not installed');
+    }
+
+    // ── Check legacy `plugins` field (backward-compat warning) ──────────────
+    if (loaded.data['plugins'] !== undefined && loaded.data['plugin'] === undefined) {
+      warnings.push(
+        `${basename}: legacy "plugins" field present (should be "plugin") — run "omd uninstall && omd install" to migrate`,
+      );
+      log(`  [WARN] ${basename}: legacy "plugins" field present (should be "plugin")`);
+    }
+
+    // ── Check plugin shape ────────────────────────────────────────────────────
+    const pluginField = loaded.data['plugin'] ?? loaded.data['plugins'];
+    if (
+      pluginField !== undefined &&
+      !Array.isArray(pluginField) &&
+      typeof pluginField !== 'object' &&
+      typeof pluginField !== 'string'
+    ) {
+      issues.push(`${basename}: plugin field has invalid type — expected array, object, or string`);
+      error(`[ISSUE] ${basename}: invalid plugin shape`);
+    } else {
+      log('  plugin field: valid');
+    }
+  }
+
+  // ── Check: rule dir existence (warning, not issue) ─────────────────────────
+  log('Checking rule directory...');
+  const ruleBase = join(homedir(), '.local', 'share', RULE_DIR_NAME);
+  if (!ruleDirExists) {
+    warnings.push(`Rule directory not found at ${ruleBase}`);
+    log(`  ${ruleBase}: not found (plugin rules not installed — this is optional)`);
+  } else {
+    log(`  ${ruleBase}: exists`);
+  }
+
+  // ── Check: package cache directory ────────────────────────────────────────
+  log('Checking OpenCode package cache...');
+  const cachePaths = resolveCachePaths(env, fs);
+  if (cachePaths.length === 0) {
+    info.push('No opencode-rules-md cache found under ~/.cache/opencode/packages/');
+    log('  no cache entries match opencode-rules-md*');
+  } else {
+    log(`  cache entries: ${cachePaths.join(', ')}`);
+  }
+
+  // ── Check: config dir writable ─────────────────────────────────────────────
+  const configDir = env.OPENCODE_CONFIG_DIR ?? join(homedir(), '.config', 'opencode');
+  log('Checking config directory write access...');
+  const parentDir = dirname(configDir);
+  if (!fs.existsSync(parentDir)) {
+    issues.push(`Config parent directory does not exist: ${parentDir}`);
+    error(`[ISSUE] Config dir parent missing: ${parentDir}`);
+  } else {
+    log(`  ${parentDir}: writable`);
+  }
+
+  // ── Summary ────────────────────────────────────────────────────────────────
+  log('');
+  if (issues.length === 0) {
+    log('omd doctor: all checks passed ✓');
+  } else {
+    error(`omd doctor: ${issues.length} issue(s) found — fix before using the plugin`);
+    error(`Run 'omd --help' for usage information`);
+  }
+
+  return {
+    ok: issues.length === 0,
+    issues,
+    warnings,
+    info,
+  };
+};

package/src/cli/uninstall.ts

@@ -0,0 +1,177 @@
+// ---------------------------------------------------------------------------
+// src/cli/uninstall.ts — `omd uninstall` command implementation.
+//
+// Removes opencode-rules-md from opencode.json and tui.json, and (with
+// `--purge`) wipes the OpenCode package cache. Two important fixes vs.
+// the previous implementation:
+//
+//   1. We read & write `data['plugin']` (singular), the field OpenCode
+//      actually honors. The previous code wrote `data['plugins']` (plural),
+//      which OpenCode silently ignored — so "uninstall" used to leave
+//      the plugin effectively installed.
+//   2. We also strip a stale `data['plugins']` entry if it exists, so
+//      users who upgraded from a buggy `omd install` get their legacy
+//      field cleaned up too.
+//   3. We purge ~/.cache/opencode/packages/opencode-rules-md* (the real
+//      cache OpenCode uses), not the old ~/.cache/opencode/node_modules
+//      path.
+// ---------------------------------------------------------------------------
+
+import { join } from 'path';
+import {
+  loadGlobalConfig,
+  backupIfWritable,
+  rotateBackups,
+  writeAtomically,
+  type CliFs,
+} from './config.js';
+import { resolveCachePaths, purgeDirectory } from './update.js';
+
+export const CONFIG_BASENAMES = ['opencode', 'tui'] as const;
+
+export interface UninstallOptions {
+  /** Also remove ~/.cache/opencode/packages/opencode-rules-md*. */
+  purge?: boolean;
+  /** Run the full pipeline without writing to disk. */
+  dryRun?: boolean;
+  /** Reserved for future prompts — no-op today. */
+  yes?: boolean;
+}
+
+export interface UninstallResultPerFile {
+  path: string;
+  status: 'wrote' | 'skipped' | 'error';
+  backup: string | null;
+}
+
+export interface UninstallResult {
+  status: 'wrote' | 'skipped';
+  results: UninstallResultPerFile[];
+  purged: boolean;
+}
+
+/**
+ * Strip `opencode-rules-md` entries from a config payload, cleaning both
+ * the modern `plugin` field (array or single string) and any legacy
+ * `plugins` field. Returns a tuple [newData, removedCount].
+ *
+ * `removedCount > 0` indicates the file actually needs to be rewritten.
+ */
+function stripFromData(data: Record<string, unknown>): {
+  next: Record<string, unknown>;
+  removed: number;
+} {
+  let removed = 0;
+  const next: Record<string, unknown> = { ...data };
+
+  // Modern field: `plugin` (singular). Accept array or single string.
+  const currentRaw = next['plugin'] ?? next['plugins'];
+  if (currentRaw !== undefined) {
+    if (typeof currentRaw === 'string') {
+      if (currentRaw.startsWith('opencode-rules-md')) {
+        delete next['plugin'];
+        delete next['plugins'];
+        removed += 1;
+      }
+    } else if (Array.isArray(currentRaw)) {
+      const filtered = (currentRaw as unknown[]).filter(
+        (p) => !(typeof p === 'string' && p.startsWith('opencode-rules-md')),
+      );
+      if (filtered.length !== currentRaw.length) {
+        removed += currentRaw.length - filtered.length;
+        if (filtered.length === 0) {
+          delete next['plugin'];
+          delete next['plugins'];
+        } else {
+          next['plugin'] = filtered;
+          delete next['plugins'];
+        }
+      }
+    }
+  }
+
+  return { next, removed };
+}
+
+/**
+ * Uninstall opencode-rules-md from both opencode.json and tui.json configs.
+ *
+ * Options:
+ *   purge     — also remove ~/.cache/opencode/packages/opencode-rules-md*
+ *   dryRun    — run full pipeline without writing to disk
+ *   yes       — reserved
+ */
+export const runUninstall = (
+  opts: UninstallOptions = {},
+  fs: CliFs,
+  env: NodeJS.ProcessEnv,
+): UninstallResult => {
+  const results: UninstallResultPerFile[] = [];
+  let anyProcessed = false;
+  let purged = false;
+
+  // ── Purge cache if requested ────────────────────────────────────────────
+  if (opts.purge) {
+    const cachePaths = resolveCachePaths(env, fs);
+    for (const cachePath of cachePaths) {
+      try {
+        if (fs.existsSync(cachePath)) {
+          purgeDirectory(fs, cachePath);
+          purged = true;
+        }
+      } catch {
+        // best-effort — purge failure is non-fatal
+      }
+    }
+  }
+
+  // ── Remove plugin from both configs ─────────────────────────────────────
+  for (const basename of CONFIG_BASENAMES) {
+    const loaded = loadGlobalConfig(fs, env, basename);
+
+    if (!loaded.exists) {
+      results.push({ path: loaded.path, status: 'skipped', backup: null });
+      continue;
+    }
+
+    const { next, removed } = stripFromData(loaded.data);
+
+    if (removed === 0) {
+      results.push({ path: loaded.path, status: 'skipped', backup: null });
+      continue;
+    }
+
+    anyProcessed = true;
+
+    const newContent = JSON.stringify(next, null, 2) + '\n';
+
+    if (opts.dryRun) {
+      results.push({ path: loaded.path, status: 'wrote', backup: null });
+      continue;
+    }
+
+    // Backup the existing file before rewriting.
+    const backup = backupIfWritable(fs, loaded.path);
+    if (backup !== undefined) {
+      const segs = loaded.path.replace(/\\/g, '/').split('/');
+      const base = segs[segs.length - 1] ?? loaded.path;
+      const dot = base.lastIndexOf('.');
+      const name = dot >= 0 ? base.slice(0, dot) : base;
+      const dir = join(...segs.slice(0, -1));
+      rotateBackups(fs, dir, name, 3);
+    }
+
+    writeAtomically(fs, loaded.path, newContent);
+    results.push({
+      path: loaded.path,
+      status: 'wrote',
+      backup: backup ?? null,
+    });
+  }
+
+  return {
+    status: anyProcessed || purged ? 'wrote' : 'skipped',
+    results,
+    purged,
+  };
+};