opencode-system-metrics-tui 0.1.12 → 0.1.13

package/README.md

@@ -3,7 +3,7 @@
 ## Install globally in OpenCode
 
 ```powershell
-opencode plugin -g opencode-system-metrics-tui@0.1.12 --force
+opencode plugin -g opencode-system-metrics-tui@0.1.13 --force
 ```
 
 This is the primary installation path. The version must match `package.json`; `--force` asks OpenCode to refresh its package cache. The helper below skips OpenCode when the expected artifact is already current. Verify the actual installed artifact afterward:
@@ -17,6 +17,19 @@ npm run verify-installation
 
 Restart OpenCode after installation. This installs the plugin globally for all projects. The OpenCode cache directory name, including `@latest`, is only a package-specifier label and does not prove the package version. Verification reads the nested package's own `package.json` and checks `dist/tui.js`; it reports stale entries without deleting anything.
 
+### Uninstall safely
+
+This project provides a safe helper; OpenCode does **not** provide a native uninstall command. It defaults to both observed global configuration roots (`~/.config/opencode` and `~/.opencode`), shows a plan, and requires `--yes` before changing anything. It removes only this plugin from OpenCode plugin arrays and verified cache entries. It never removes OpenCode, Node, Bun, shared dependencies, or repository files.
+
+```powershell
+npm run uninstall-plugin -- --dry-run
+npm run uninstall-plugin -- --yes
+npm run uninstall-plugin -- --purge-cache --yes  # also remove all verified stale versions
+npm run uninstall-plugin -- --local              # current project's .opencode config
+```
+
+Use `--dry-run` first. Without `--yes`, no changes are made. An unversioned package entry removes all verified cache entries for this package; `--purge-cache` explicitly removes all verified entries even when no package entry is configured.
+
 OpenCode TUI plugin that adds live CPU, RAM, GPU, GPU VRAM, temperature, and network metrics to the `sidebar_content` slot.
 
 The README is available in **Español**, **English**, and **Português**.
@@ -63,6 +76,19 @@ opencode
 
 `npm run install-font` ejecuta el instalador compilado incluido en `dist/`, instala **Hack Nerd Font** únicamente para el usuario actual, no se ejecuta automáticamente durante `npm install` y solicita confirmación antes de descargar la fuente oficial.
 
+### Desinstalación segura
+
+Este proyecto incluye un asistente seguro; OpenCode **no** tiene un comando nativo de desinstalación. Por defecto actúa sobre ambas raíces globales observadas (`~/.config/opencode` y `~/.opencode`), muestra un informe y requiere `--yes` antes de cambiar archivos. Solo elimina este paquete de las listas de plugins y sus entradas de caché verificadas.
+
+```bash
+npm run uninstall-plugin -- --dry-run
+npm run uninstall-plugin -- --yes
+npm run uninstall-plugin -- --purge-cache --yes  # también elimina versiones antiguas verificadas
+npm run uninstall-plugin -- --local              # configuración .opencode del proyecto actual
+```
+
+Usa primero `--dry-run`. Sin `--yes` no se realizan cambios. Una entrada de paquete sin versión elimina todas las entradas de caché verificadas de este paquete; `--purge-cache` las elimina explícitamente.
+
 Comandos adicionales:
 
 ```bash
@@ -94,7 +120,7 @@ npm publish --access public
 En otro equipo:
 
 ```bash
-opencode plugin opencode-system-metrics-tui@0.1.12
+opencode plugin opencode-system-metrics-tui@0.1.13
 ```
 
 El paquete exporta tanto la raíz (`opencode-system-metrics-tui`) como `./tui`; ambas rutas cargan el mismo bundle TUI.
@@ -104,8 +130,8 @@ El instalador de OpenCode configura el plugin TUI automáticamente. Reinicia Ope
 Publicar en npm e instalar en OpenCode son pasos distintos:
 
 - `npm publish --access public` publica el paquete en npm.
-- `opencode plugin opencode-system-metrics-tui@0.1.12` lo instala solo en el proyecto actual.
-- `opencode plugin -g opencode-system-metrics-tui@0.1.12 --force` lo instala globalmente para todos los proyectos.
+- `opencode plugin opencode-system-metrics-tui@0.1.13` lo instala solo en el proyecto actual.
+- `opencode plugin -g opencode-system-metrics-tui@0.1.13 --force` lo instala globalmente para todos los proyectos.
 
 ### Verificación
 
@@ -161,6 +187,19 @@ opencode
 
 `npm run install-font` runs the compiled installer included in `dist/`, installs **Hack Nerd Font** for the current user only, is not executed automatically by `npm install`, and asks for confirmation before downloading the official font.
 
+### Safe uninstall
+
+This project provides a safe helper; OpenCode does **not** provide a native uninstall command. It targets both observed global configuration roots (`~/.config/opencode` and `~/.opencode`) by default, prints a report, and requires `--yes` before changing anything. It removes only this package from plugin lists and its verified cache entries.
+
+```bash
+npm run uninstall-plugin -- --dry-run
+npm run uninstall-plugin -- --yes
+npm run uninstall-plugin -- --purge-cache --yes  # also remove all verified stale versions
+npm run uninstall-plugin -- --local              # current project's .opencode config
+```
+
+Run `--dry-run` first. Without `--yes`, no changes are made. An unversioned package entry removes all verified cache entries for this package; `--purge-cache` explicitly removes all verified entries. Neither mode removes OpenCode, Node, Bun, shared dependencies, or repository files.
+
 Extra commands:
 
 ```bash
@@ -192,7 +231,7 @@ npm publish --access public
 On another machine:
 
 ```bash
-opencode plugin opencode-system-metrics-tui@0.1.12
+opencode plugin opencode-system-metrics-tui@0.1.13
 ```
 
 The package exports both the root (`opencode-system-metrics-tui`) and `./tui`; both paths load the same TUI bundle.
@@ -202,8 +241,8 @@ The OpenCode installer configures the TUI plugin automatically. Restart OpenCode
 Publishing to npm and installing in OpenCode are separate steps:
 
 - `npm publish --access public` publishes the package to npm.
-- `opencode plugin opencode-system-metrics-tui@0.1.12` installs it for the current project only.
-- `opencode plugin -g opencode-system-metrics-tui@0.1.12 --force` installs it globally for all projects.
+- `opencode plugin opencode-system-metrics-tui@0.1.13` installs it for the current project only.
+- `opencode plugin -g opencode-system-metrics-tui@0.1.13 --force` installs it globally for all projects.
 
 ### Verification
 
@@ -256,6 +295,19 @@ opencode
 
 `npm run install-font` executa o instalador compilado incluído em `dist/`, instala a **Hack Nerd Font** somente para o usuário atual, não é executado automaticamente durante `npm install` e pede confirmação antes de baixar a fonte oficial.
 
+### Desinstalação segura
+
+Este projeto inclui um assistente seguro; o OpenCode **não** oferece um comando nativo de desinstalação. Por padrão, ele usa ambas as raízes globais observadas (`~/.config/opencode` e `~/.opencode`), mostra um relatório e exige `--yes` antes de alterar arquivos. Remove apenas este pacote das listas de plugins e suas entradas de cache verificadas.
+
+```bash
+npm run uninstall-plugin -- --dry-run
+npm run uninstall-plugin -- --yes
+npm run uninstall-plugin -- --purge-cache --yes  # também remove versões antigas verificadas
+npm run uninstall-plugin -- --local              # configuração .opencode do projeto atual
+```
+
+Execute primeiro com `--dry-run`. Sem `--yes`, nenhuma alteração é feita. Uma entrada de pacote sem versão remove todas as entradas de cache verificadas deste pacote; `--purge-cache` remove explicitamente todas as entradas verificadas.
+
 Comandos adicionais:
 
 ```bash
@@ -287,7 +339,7 @@ npm publish --access public
 Em outro computador:
 
 ```bash
-opencode plugin opencode-system-metrics-tui@0.1.12
+opencode plugin opencode-system-metrics-tui@0.1.13
 ```
 
 O pacote exporta tanto a raiz (`opencode-system-metrics-tui`) quanto `./tui`; os dois caminhos carregam o mesmo bundle TUI.
@@ -297,8 +349,8 @@ O instalador do OpenCode configura o plugin TUI automaticamente. Reinicie o Open
 Publicar no npm e instalar no OpenCode são etapas diferentes:
 
 - `npm publish --access public` publica o pacote no npm.
-- `opencode plugin opencode-system-metrics-tui@0.1.12` instala o plugin apenas no projeto atual.
-- `opencode plugin -g opencode-system-metrics-tui@0.1.12 --force` instala o plugin globalmente para todos os projetos.
+- `opencode plugin opencode-system-metrics-tui@0.1.13` instala o plugin apenas no projeto atual.
+- `opencode plugin -g opencode-system-metrics-tui@0.1.13 --force` instala o plugin globalmente para todos os projetos.
 
 ### Verificação
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-system-metrics-tui",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "description": "OpenCode TUI sidebar plugin for live system metrics",
   "license": "MIT",
   "type": "module",
@@ -25,7 +25,8 @@
     "typecheck": "tsc --noEmit",
     "install-font": "node dist/install-hack-font.js",
     "verify-installation": "tsx scripts/plugin-installation.ts",
-    "install-plugin": "tsx scripts/install-plugin.ts"
+    "install-plugin": "tsx scripts/install-plugin.ts",
+    "uninstall-plugin": "tsx scripts/uninstall-plugin.ts"
   },
   "engines": {
     "node": ">=18"

package/scripts/uninstall-plugin.ts

@@ -0,0 +1,202 @@
+import { lstat, readFile, readdir, rm, stat, writeFile } from "node:fs/promises"
+import { homedir } from "node:os"
+import { basename, isAbsolute, join, relative, resolve } from "node:path"
+import { fileURLToPath } from "node:url"
+
+export type UninstallScope = "global" | "local"
+
+export type ConfigChange = {
+  path: string
+  removed: string[]
+  content: string
+}
+
+export type CacheCandidate = {
+  path: string
+  version: string
+}
+
+export type UninstallPlan = {
+  configChanges: ConfigChange[]
+  cacheCandidates: CacheCandidate[]
+  warnings: string[]
+}
+
+type PackageManifest = { name?: unknown; version?: unknown }
+
+const packageManifest = JSON.parse(await readFile(new URL("../package.json", import.meta.url), "utf8")) as { name: string }
+const packageName = packageManifest.name
+
+function isPackageSpec(value: unknown, name: string): value is string {
+  return typeof value === "string" && (value === name || value.startsWith(`${name}@`))
+}
+
+function filterPluginArrays(value: unknown, name: string, removed: string[]): unknown {
+  if (Array.isArray(value)) return value
+  if (value === null || typeof value !== "object") return value
+
+  const result: Record<string, unknown> = {}
+  for (const [key, child] of Object.entries(value)) {
+    if ((key === "plugin" || key === "plugins") && Array.isArray(child)) {
+      result[key] = child.filter((entry) => {
+        const spec = typeof entry === "string" ? entry : Array.isArray(entry) ? entry[0] : undefined
+        if (!isPackageSpec(spec, name)) return true
+        removed.push(spec)
+        return false
+      })
+    } else {
+      result[key] = filterPluginArrays(child, name, removed)
+    }
+  }
+  return result
+}
+
+export function filterPluginConfig(content: string, name = packageName): { content: string; removed: string[] } {
+  const parsed: unknown = JSON.parse(content)
+  const removed: string[] = []
+  const filtered = filterPluginArrays(parsed, name, removed)
+  const newline = content.includes("\r\n") ? "\r\n" : "\n"
+  const serialized = JSON.stringify(filtered, null, 2)
+  return { content: `${serialized.replaceAll("\n", newline)}${newline}`, removed }
+}
+
+export function getConfigPaths(scope: UninstallScope, cwd = process.cwd(), home = homedir(), env: NodeJS.ProcessEnv = process.env): string[] {
+  if (scope === "local") return [join(cwd, ".opencode", "tui.json"), join(cwd, ".opencode", "opencode.json"), join(cwd, "opencode.json")]
+  const configRoot = env.XDG_CONFIG_HOME ?? join(home, ".config")
+  const globalRoots = [join(configRoot, "opencode"), join(home, ".config", "opencode"), join(home, ".opencode")]
+  return [...new Set([
+    ...globalRoots.flatMap((root) => [join(root, "tui.json"), join(root, "opencode.json")]),
+    join(configRoot, "opencode.json"),
+  ])]
+}
+
+export function getCachePackagesRoot(home = homedir(), env: NodeJS.ProcessEnv = process.env): string {
+  const cacheRoot = env.OPENCODE_CACHE_DIR ?? env.XDG_CACHE_HOME ?? join(home, ".cache")
+  return join(cacheRoot, "opencode", "packages")
+}
+
+function isWithin(root: string, candidate: string): boolean {
+  const fromRoot = relative(resolve(root), resolve(candidate))
+  return fromRoot !== "" && !fromRoot.startsWith("..") && !isAbsolute(fromRoot)
+}
+
+async function readPackageManifest(path: string): Promise<PackageManifest | undefined> {
+  try {
+    return JSON.parse(await readFile(path, "utf8")) as PackageManifest
+  } catch {
+    return undefined
+  }
+}
+
+export async function findCacheCandidates(
+  cacheRoot: string,
+  name = packageName,
+  versions: Set<string> | undefined = undefined,
+  purgeCache = false,
+): Promise<{ candidates: CacheCandidate[]; warnings: string[] }> {
+  const root = resolve(cacheRoot)
+  const candidates: CacheCandidate[] = []
+  const warnings: string[] = []
+  let entries
+  try {
+    if ((await lstat(root)).isSymbolicLink()) throw new Error(`Unexpected symbolic link cache root: ${root}`)
+    entries = await readdir(root, { withFileTypes: true })
+  } catch (error) {
+    if ((error as NodeJS.ErrnoException).code === "ENOENT") return { candidates, warnings }
+    if (error instanceof Error && error.message.startsWith("Unexpected symbolic link cache root:")) throw error
+    throw new Error(`Cannot inspect OpenCode cache root: ${root}`)
+  }
+
+  for (const entry of entries) {
+    if (!entry.isDirectory() || !entry.name.startsWith(`${name}@`)) continue
+    const candidatePath = join(root, entry.name)
+    if (!isWithin(root, candidatePath) || basename(candidatePath) !== entry.name) throw new Error(`Unexpected cache path: ${candidatePath}`)
+    const manifest = await readPackageManifest(join(candidatePath, "node_modules", name, "package.json"))
+    if (manifest?.name !== name || typeof manifest.version !== "string") {
+      warnings.push(`Skipped unverified cache entry: ${candidatePath}`)
+      continue
+    }
+    if (purgeCache || versions?.has(manifest.version)) candidates.push({ path: candidatePath, version: manifest.version })
+  }
+  candidates.sort((left, right) => left.path.localeCompare(right.path))
+  return { candidates, warnings }
+}
+
+export async function buildUninstallPlan(options: {
+  scope: UninstallScope
+  configPaths?: string[]
+  cacheRoot?: string
+  packageName?: string
+  purgeCache?: boolean
+}): Promise<UninstallPlan> {
+  const name = options.packageName ?? packageName
+  const configChanges: ConfigChange[] = []
+  const versions = new Set<string>()
+  const warnings: string[] = []
+  let hasUnversionedPackage = false
+
+  for (const path of options.configPaths ?? getConfigPaths(options.scope)) {
+    let content: string
+    try {
+      if ((await lstat(path)).isSymbolicLink()) throw new Error(`Unexpected symbolic link config path: ${path}`)
+      content = await readFile(path, "utf8")
+    }
+    catch (error) {
+      if ((error as NodeJS.ErrnoException).code === "ENOENT") continue
+      throw new Error(`Cannot read OpenCode config: ${path}`)
+    }
+    let filtered: { content: string; removed: string[] }
+    try { filtered = filterPluginConfig(content, name) }
+    catch { throw new Error(`Malformed OpenCode config: ${path}`) }
+    if (filtered.removed.length === 0) continue
+    for (const spec of filtered.removed) {
+      if (spec === name) hasUnversionedPackage = true
+      const version = spec.slice(name.length + 1)
+      if (version && version !== "latest") versions.add(version)
+    }
+    configChanges.push({ path, removed: filtered.removed, content: filtered.content })
+  }
+
+  const cache = await findCacheCandidates(options.cacheRoot ?? getCachePackagesRoot(), name, versions, options.purgeCache || hasUnversionedPackage)
+  return { configChanges, cacheCandidates: cache.candidates, warnings: [...warnings, ...cache.warnings] }
+}
+
+function printPlan(plan: UninstallPlan, dryRun: boolean): void {
+  console.log(dryRun ? "Uninstall dry run (no changes will be made):" : "Uninstall plan:")
+  for (const change of plan.configChanges) console.log(`Config ${dryRun ? "would remove" : "remove"} ${change.removed.join(", ")} from ${change.path}`)
+  for (const candidate of plan.cacheCandidates) console.log(`Cache ${dryRun ? "would remove" : "remove"} ${candidate.path} (${candidate.version})`)
+  if (plan.configChanges.length === 0 && plan.cacheCandidates.length === 0) console.log("No matching plugin configuration or verified cache entries found.")
+  for (const warning of plan.warnings) console.warn(`Warning: ${warning}`)
+}
+
+export async function uninstallPlugin(args = process.argv.slice(2)): Promise<void> {
+  const scope: UninstallScope = args.includes("--local") ? "local" : "global"
+  if (args.includes("--local") && args.includes("--global")) throw new Error("Choose only one scope: --local or --global")
+  const purgeCache = args.includes("--purge-cache")
+  const dryRun = args.includes("--dry-run") || args.includes("--report")
+  const yes = args.includes("--yes")
+  const plan = await buildUninstallPlan({ scope, purgeCache })
+  printPlan(plan, dryRun)
+  if (dryRun || (plan.configChanges.length === 0 && plan.cacheCandidates.length === 0)) return
+  if (!yes) {
+    console.log("Destructive uninstall requires --yes; no changes were made.")
+    return
+  }
+
+  for (const change of plan.configChanges) {
+    if (!isAbsolute(change.path) || (await lstat(change.path)).isSymbolicLink()) throw new Error(`Unexpected config path: ${change.path}`)
+    const mode = (await stat(change.path)).mode
+    await writeFile(change.path, change.content, { mode })
+  }
+  const cacheRoot = resolve(getCachePackagesRoot())
+  for (const candidate of plan.cacheCandidates) {
+    if (!isWithin(cacheRoot, candidate.path) || !basename(candidate.path).startsWith(`${packageName}@`) || (await lstat(candidate.path)).isSymbolicLink()) throw new Error(`Unexpected cache path: ${candidate.path}`)
+    await rm(candidate.path, { recursive: true, force: false })
+  }
+  console.log("Uninstall completed. Restart OpenCode if it was running.")
+}
+
+if (process.argv[1] !== undefined && resolve(process.argv[1]) === resolve(fileURLToPath(import.meta.url))) {
+  try { await uninstallPlugin() }
+  catch (error) { console.error(error instanceof Error ? error.message : String(error)); process.exitCode = 1 }
+}