opencode-system-metrics-tui 0.1.3 → 0.1.4

package/README.md

@@ -1,5 +1,22 @@
 # OpenCode System Metrics TUI
 
+## Install globally in OpenCode
+
+```powershell
+opencode plugin -g opencode-system-metrics-tui@0.1.3 --force
+```
+
+This is the primary installation path. The version must match `package.json`; `--force` asks OpenCode to refresh its package cache. Verify the actual installed artifact afterward:
+
+```powershell
+npm run install-plugin
+npm run verify-installation
+```
+
+`npm run install-plugin` runs the same global OpenCode installer command with the current `package.json` version. The explicit command above is provided for users installing without this checkout.
+
+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.
+
 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**.
@@ -72,7 +89,7 @@ npm publish --access public
 En otro equipo:
 
 ```bash
-opencode plugin opencode-system-metrics-tui
+opencode plugin opencode-system-metrics-tui@0.1.3
 ```
 
 El paquete exporta tanto la raíz (`opencode-system-metrics-tui`) como `./tui`; ambas rutas cargan el mismo bundle TUI.
@@ -82,12 +99,14 @@ 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` lo instala solo en el proyecto actual.
-- `opencode plugin -g opencode-system-metrics-tui` lo instala globalmente para todos los proyectos.
+- `opencode plugin opencode-system-metrics-tui@0.1.3` lo instala solo en el proyecto actual.
+- `opencode plugin -g opencode-system-metrics-tui@0.1.3 --force` lo instala globalmente para todos los proyectos.
 
 ### Verificación
 
 ```bash
+npm run install-plugin
+npm run verify-installation
 npm test
 npm run typecheck
 npm run build
@@ -161,7 +180,7 @@ npm publish --access public
 On another machine:
 
 ```bash
-opencode plugin opencode-system-metrics-tui
+opencode plugin opencode-system-metrics-tui@0.1.3
 ```
 
 The package exports both the root (`opencode-system-metrics-tui`) and `./tui`; both paths load the same TUI bundle.
@@ -171,12 +190,14 @@ 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` installs it for the current project only.
-- `opencode plugin -g opencode-system-metrics-tui` installs it globally for all projects.
+- `opencode plugin opencode-system-metrics-tui@0.1.3` installs it for the current project only.
+- `opencode plugin -g opencode-system-metrics-tui@0.1.3 --force` installs it globally for all projects.
 
 ### Verification
 
 ```bash
+npm run install-plugin
+npm run verify-installation
 npm test
 npm run typecheck
 npm run build
@@ -250,7 +271,7 @@ npm publish --access public
 Em outro computador:
 
 ```bash
-opencode plugin opencode-system-metrics-tui
+opencode plugin opencode-system-metrics-tui@0.1.3
 ```
 
 O pacote exporta tanto a raiz (`opencode-system-metrics-tui`) quanto `./tui`; os dois caminhos carregam o mesmo bundle TUI.
@@ -260,8 +281,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` instala o plugin apenas no projeto atual.
-- `opencode plugin -g opencode-system-metrics-tui` instala o plugin globalmente para todos os projetos.
+- `opencode plugin opencode-system-metrics-tui@0.1.3` instala o plugin apenas no projeto atual.
+- `opencode plugin -g opencode-system-metrics-tui@0.1.3 --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.3",
+  "version": "0.1.4",
   "description": "OpenCode TUI sidebar plugin for live system metrics",
   "license": "MIT",
   "type": "module",
@@ -23,7 +23,9 @@
     "build": "bun scripts/build.ts && tsc --emitDeclarationOnly --declaration --outDir dist",
     "test": "tsx --test test/*.test.ts",
     "typecheck": "tsc --noEmit",
-    "install-font": "node dist/install-hack-font.js"
+    "install-font": "node dist/install-hack-font.js",
+    "verify-installation": "tsx scripts/plugin-installation.ts",
+    "install-plugin": "tsx scripts/install-plugin.ts"
   },
   "engines": {
     "node": ">=18"

package/scripts/install-plugin.ts

@@ -0,0 +1,30 @@
+import { execFile } from "node:child_process"
+import { readFile } from "node:fs/promises"
+import { promisify } from "node:util"
+import { formatVerificationResult, verifyPluginInstallation } from "./plugin-installation.js"
+
+const execFileAsync = promisify(execFile)
+const manifest = JSON.parse(await readFile(new URL("../package.json", import.meta.url), "utf8")) as {
+  name: string
+  version: string
+}
+const packageSpec = `${manifest.name}@${manifest.version}`
+
+console.log(`Installing ${packageSpec} globally through OpenCode`)
+try {
+  const result = await execFileAsync("opencode", ["plugin", "-g", packageSpec, "--force"], { windowsHide: true })
+  if (result.stdout.trim()) console.log(result.stdout.trim())
+  if (result.stderr.trim()) console.error(result.stderr.trim())
+} catch (error) {
+  const message = error instanceof Error ? error.message : String(error)
+  console.error(`OpenCode plugin installation failed: ${message}`)
+  process.exit(1)
+}
+
+const verification = await verifyPluginInstallation({
+  packageName: manifest.name,
+  expectedVersion: manifest.version,
+  cacheDirectory: process.env.OPENCODE_CACHE_DIR,
+})
+console.log(formatVerificationResult(verification))
+if (!verification.ok) process.exitCode = 1

package/scripts/plugin-installation.ts

@@ -0,0 +1,107 @@
+import { access, readFile, readdir } from "node:fs/promises"
+import { homedir } from "node:os"
+import { fileURLToPath } from "node:url"
+import { join, resolve } from "node:path"
+
+export type PluginVerificationOptions = {
+  cacheDirectory?: string
+  packageName: string
+  expectedVersion: string
+  distPath?: string
+}
+
+export type PluginVerification = {
+  ok: boolean
+  packagePath?: string
+  actualVersion?: string
+  staleEntries: string[]
+  errors: string[]
+}
+
+type PackageManifest = { name?: unknown; version?: unknown }
+
+export function getDefaultOpenCodeCacheDirectory(env: NodeJS.ProcessEnv = process.env, home = homedir()): string {
+  const cacheRoot = env.OPENCODE_CACHE_DIR ?? env.XDG_CACHE_HOME ?? join(home, ".cache")
+  return join(cacheRoot, "opencode", "packages")
+}
+
+async function readManifest(path: string): Promise<PackageManifest | undefined> {
+  try {
+    return JSON.parse(await readFile(path, "utf8")) as PackageManifest
+  } catch {
+    return undefined
+  }
+}
+
+async function exists(path: string): Promise<boolean> {
+  try {
+    await access(path)
+    return true
+  } catch {
+    return false
+  }
+}
+
+export async function verifyPluginInstallation(options: PluginVerificationOptions): Promise<PluginVerification> {
+  const cacheDirectory = resolve(options.cacheDirectory ?? getDefaultOpenCodeCacheDirectory())
+  const errors: string[] = []
+  const staleEntries: string[] = []
+  let packagePath: string | undefined
+  let actualVersion: string | undefined
+
+  let entries: string[]
+  try {
+    entries = (await readdir(cacheDirectory, { withFileTypes: true }))
+      .filter((entry) => entry.isDirectory() && entry.name.startsWith(`${options.packageName}@`))
+      .map((entry) => entry.name)
+  } catch {
+    return { ok: false, staleEntries, errors: [`OpenCode package cache not found: ${cacheDirectory}`] }
+  }
+
+  for (const entry of entries) {
+    const candidatePath = join(cacheDirectory, entry, "node_modules", options.packageName)
+    const manifest = await readManifest(join(candidatePath, "package.json"))
+    if (manifest?.name !== options.packageName || typeof manifest.version !== "string") {
+      staleEntries.push(join(cacheDirectory, entry))
+      continue
+    }
+    if (manifest.version === options.expectedVersion && packagePath === undefined) {
+      packagePath = candidatePath
+      actualVersion = manifest.version
+    } else if (manifest.version !== options.expectedVersion) {
+      staleEntries.push(join(cacheDirectory, entry))
+    }
+  }
+
+  if (packagePath === undefined) {
+    errors.push(`Installed ${options.packageName}@${options.expectedVersion} was not found in ${cacheDirectory}`)
+  } else if (actualVersion !== options.expectedVersion) {
+    errors.push(`Installed version is ${actualVersion ?? "unknown"}; expected ${options.expectedVersion}`)
+  }
+
+  if (packagePath !== undefined && !(await exists(join(packagePath, options.distPath ?? "dist", "tui.js")))) {
+    errors.push(`Required dist/tui.js is missing from ${packagePath}`)
+  }
+  if (staleEntries.length > 0) errors.push(`Stale OpenCode cache entries detected: ${staleEntries.join(", ")}`)
+
+  return { ok: errors.length === 0, packagePath, actualVersion, staleEntries, errors }
+}
+
+export function formatVerificationResult(result: PluginVerification): string {
+  if (result.ok) return `Verified OpenCode plugin ${result.actualVersion} at ${result.packagePath}`
+  return result.errors.join("\n")
+}
+
+if (process.argv[1] !== undefined && resolve(process.argv[1]) === resolve(fileURLToPath(import.meta.url))) {
+  const packageManifest = JSON.parse(await readFile(new URL("../package.json", import.meta.url), "utf8")) as {
+    name: string
+    version: string
+  }
+  const result = await verifyPluginInstallation({
+    packageName: packageManifest.name,
+    expectedVersion: packageManifest.version,
+    cacheDirectory: process.env.OPENCODE_CACHE_DIR,
+  })
+  console.log(formatVerificationResult(result))
+  if (!result.ok) process.exitCode = 1
+}