opencode-rules-md 0.8.5 → 0.9.0

package/src/cli/status.ts

@@ -1,24 +1,37 @@
 // ---------------------------------------------------------------------------
 // src/cli/status.ts — `omd status` and `omd doctor` command implementations.
 //
-// runStatus: read-only probe for both configs. Reports path, format,
-// installed specifier, other plugins, and installed-vs-latest version.
-// runDoctor: health checks grouped into issues (exit 1), warnings, and info.
+// 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 } from 'path';
+import { join, dirname, extname } from 'path';
 import { homedir } from 'os';
-import { extname } from 'path';
 import {
   loadGlobalConfig,
   matchesPlugin,
-  normalizePlugin,
+  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;
@@ -66,30 +79,35 @@ export const runStatus = async (
   fs: CliFs,
   env: NodeJS.ProcessEnv,
   log: (s: string) => void,
+  opts: StatusOptions = {},
 ): Promise<StatusResult> => {
   const configs: StatusEntry[] = [];
-  const latest = await fetchLatestVersion();
+  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 = normalizePlugin(loaded.data['plugins']);
-    const match = plugins.find(p => matchesPlugin(p));
+    const plugins = readInstalledPlugins(loaded);
+    const match = plugins.find((p) => matchesPlugin(p)) ?? null;
 
     const entry: StatusEntry = {
       basename,
       path: loaded.path,
       format,
-      installed: match ?? null,
-      notInstalled: !loaded.exists ? true : match === undefined || match === null,
-      otherPlugins: plugins.filter(p => !matchesPlugin(p)),
+      installed: match,
+      notInstalled: !loaded.exists || match === null,
+      otherPlugins: plugins.filter((p) => !matchesPlugin(p)),
       latest,
-      isLatest: match !== undefined && latest !== null ? match === `opencode-rules-md@${latest}` : null,
+      isLatest:
+        match !== null && latest !== null
+          ? match === `opencode-rules-md@${latest}`
+          : null,
     };
 
     configs.push(entry);
 
-    // ── Print status lines ──────────────────────────────────────────────────
     if (!loaded.exists) {
       log(`omd: ${basename}.json — config not found at ${loaded.path}`);
       continue;
@@ -97,14 +115,15 @@ export const runStatus = async (
 
     log(`omd: ${basename}${format} — ${loaded.path}`);
     if (match) {
-      const isLatestLabel = entry.isLatest === true
-        ? ' (latest)'
-        : entry.isLatest === false
-          ? ` (behind: latest is ${latest ?? 'unknown'})`
-          : '';
+      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`);
+      log('  opencode-rules-md: not installed');
     }
 
     if (entry.otherPlugins.length > 0) {
@@ -119,13 +138,16 @@ export const runStatus = async (
 
 /**
  * Run the doctor command: health checks for the plugin environment.
- * - Node >= 20: issue if below
- * - Bun on PATH: issue if absent
- * - Configs readable: issue if absent or malformed
- * - Plugin shape valid: issue if malformed
- * - Rule dir existence: warning if absent
- * - Config dir writable: issue if not writable
- * - Package freshness: info line about update availability
+ *
+ * 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.
  */
@@ -147,7 +169,7 @@ export const runDoctor = async (
   let hasBun = opts.hasBun;
   if (hasBun === undefined) {
     const pathEnv = (env.PATH ?? '').split(':');
-    hasBun = pathEnv.some(p => {
+    hasBun = pathEnv.some((p) => {
       try {
         const { existsSync } = require('node:fs') as typeof import('node:fs');
         return existsSync(p + '/bun');
@@ -179,7 +201,7 @@ export const runDoctor = async (
   // ── Check: both configs readable and valid ─────────────────────────────────
   for (const basename of CONFIG_BASENAMES) {
     log(`Checking ${basename} config...`);
-    const loaded = loadGlobalConfig(fs, env, basename);
+    const loaded: LoadedConfig = loadGlobalConfig(fs, env, basename);
 
     if (!loaded.exists) {
       warnings.push(`${basename} config not found at ${loaded.path}`);
@@ -188,23 +210,37 @@ export const runDoctor = async (
     }
 
     log(`  ${basename}${extname(loaded.path)}: ${loaded.path}`);
-    const plugins = normalizePlugin(loaded.data['plugins']);
-    const match = plugins.find(p => matchesPlugin(p));
+    const plugins = readInstalledPlugins(loaded);
+    const match = plugins.find((p) => matchesPlugin(p)) ?? null;
 
     if (match) {
-      info.push(`${basename}: opencode-rules-md@${match ?? 'unknown'} installed`);
+      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`);
+      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 ────────────────────────────────────────────────────
-    if (loaded.data['plugins'] !== undefined && !Array.isArray(loaded.data['plugins']) && typeof loaded.data['plugins'] !== 'object') {
-      issues.push(`${basename}: plugins field has invalid type — expected array or object`);
+    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(`  plugins field: valid`);
+      log('  plugin field: valid');
     }
   }
 
@@ -218,6 +254,16 @@ export const runDoctor = async (
     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...');
@@ -244,4 +290,4 @@ export const runDoctor = async (
     warnings,
     info,
   };
-};
+};

package/src/cli/uninstall.ts

@@ -1,28 +1,40 @@
 // ---------------------------------------------------------------------------
 // src/cli/uninstall.ts — `omd uninstall` command implementation.
 //
-// Dual-config uninstall: removes opencode-rules-md entries from both configs.
-// --purge removes ONLY ~/.cache/opencode/node_modules/opencode-rules-md and
-// NEVER touches rule directories.
+// 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 { dirname, join } from 'path';
-import { homedir } from 'os';
+import { join } from 'path';
 import {
   loadGlobalConfig,
-  matchesPlugin,
-  normalizePlugin,
   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;
 }
 
@@ -38,13 +50,56 @@ export interface UninstallResult {
   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/node_modules/opencode-rules-md
+ *   purge     — also remove ~/.cache/opencode/packages/opencode-rules-md*
  *   dryRun    — run full pipeline without writing to disk
- *   yes       — accepted for future prompts, no-op here
+ *   yes       — reserved
  */
 export const runUninstall = (
   opts: UninstallOptions = {},
@@ -57,37 +112,15 @@ export const runUninstall = (
 
   // ── Purge cache if requested ────────────────────────────────────────────
   if (opts.purge) {
-    const cachePath = join(
-      homedir(),
-      '.cache',
-      'opencode',
-      'node_modules',
-      'opencode-rules-md',
-    );
-    if (fs.existsSync(cachePath)) {
+    const cachePaths = resolveCachePaths(env, fs);
+    for (const cachePath of cachePaths) {
       try {
-        // Check if it's a directory or a file
-        const entries = fs.readdirSync(cachePath);
-        if (entries.length === 0) {
-          // Empty directory — remove it
-          fs.rmdirSync(cachePath);
-        } else {
-          // Has contents — remove contents then the dir
-          for (const entry of entries) {
-            const entryPath = join(cachePath, entry);
-            if (fs.existsSync(entryPath)) {
-              try {
-                fs.unlinkSync(entryPath);
-              } catch {
-                // ignore individual file failures
-              }
-            }
-          }
-          fs.rmdirSync(cachePath);
+        if (fs.existsSync(cachePath)) {
+          purgeDirectory(fs, cachePath);
+          purged = true;
         }
-        purged = true;
       } catch {
-        // best-effort — cache purge failure is non-fatal
+        // best-effort — purge failure is non-fatal
       }
     }
   }
@@ -95,39 +128,37 @@ export const runUninstall = (
   // ── Remove plugin from both configs ─────────────────────────────────────
   for (const basename of CONFIG_BASENAMES) {
     const loaded = loadGlobalConfig(fs, env, basename);
-    const plugins = normalizePlugin(loaded.data['plugins']);
 
-    // Filter out all opencode-rules-md entries
-    const remaining = plugins.filter(p => !matchesPlugin(p));
+    if (!loaded.exists) {
+      results.push({ path: loaded.path, status: 'skipped', backup: null });
+      continue;
+    }
 
-    if (remaining.length === plugins.length) {
-      // Nothing to remove — no-op for this file
+    const { next, removed } = stripFromData(loaded.data);
+
+    if (removed === 0) {
       results.push({ path: loaded.path, status: 'skipped', backup: null });
       continue;
     }
 
     anyProcessed = true;
 
-    const newData = { ...loaded.data, plugins: remaining };
-    const newContent = JSON.stringify(newData, null, 2) + '\n';
+    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 if it exists
-    let backup: string | undefined;
-    if (loaded.exists) {
-      backup = backupIfWritable(fs, loaded.path);
-      if (backup !== undefined) {
-        const dir = dirname(loaded.path);
-        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;
-        rotateBackups(fs, dir, name, 3);
-      }
+    // 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);
@@ -143,4 +174,4 @@ export const runUninstall = (
     results,
     purged,
   };
-};
+};