lecodes-cli 0.20.2 → 2.0.0

package/src/commands/install.ts

@@ -1,8 +1,8 @@
 import { execFileSync } from "node:child_process"
 import { appendFileSync, chmodSync, cpSync, existsSync, mkdirSync, readFileSync, realpathSync, rmSync, symlinkSync } from "node:fs"
 import { homedir } from "node:os"
-import { basename, delimiter, dirname, join, resolve, sep } from "node:path"
-import { c, CliError, flagBool, flagStr, log, success, warn, type Args } from "../util"
+import { basename, delimiter, dirname, join, resolve } from "node:path"
+import { CliError, bool, c, defineCommand, log, str, success, warn } from "../cli"
 
 /*
  * `lecodes install` — install this standalone build so `lecodes` is on your PATH.
@@ -17,15 +17,13 @@ import { c, CliError, flagBool, flagStr, log, success, warn, type Args } from ".
  * PATH is only edited on request (`--modify-path`); otherwise we place the files and print exactly how
  * to finish (a one-liner for this shell, a line for the rc file, or `--system` which lands in
  * /usr/local/bin and needs no PATH edit). Only meaningful for the release archive — from npm/monorepo
- * source process.execPath has no bundle beside it, so it refuses.
+ * source process.execPath has no bundle beside it, so it refuses. The registry hides the command
+ * unless the running binary IS such a bundle (src/index.ts decides).
  */
 
 const isWin = process.platform === "win32"
 const HOME = homedir()
 
-/** Display a path with the home dir collapsed to `~` (for copy-pasteable hints). */
-const tildify = (p: string): string => (p === HOME || p.startsWith(HOME + sep)) ? "~" + p.slice(HOME.length) : p
-
 const safeRealpath = (p: string): string => { try { return realpathSync(p) } catch { return resolve(p) } }
 
 /** True if `dir` is already an entry in PATH (compared by resolved path). */
@@ -37,25 +35,7 @@ const onPath = (dir: string): boolean => {
   })
 }
 
-export const install = async (args: Args): Promise<void> => {
-  const bundle = dirname(process.execPath)
-  const exeName = basename(process.execPath)               // "lecodes" | "lecodes.exe"
-  const chiselName = isWin ? "chisel.exe" : "chisel"
-
-  // Guard: this must be the packaged standalone bundle (chisel + runtime/ sit next to the binary).
-  // From npm / the monorepo, process.execPath is the bun/node binary and has no companions.
-  if (!existsSync(join(bundle, "runtime")) || !existsSync(join(bundle, chiselName))) {
-    throw new CliError(
-      "`lecodes install` only works from the packaged release build (the archive containing lecodes + " +
-      "chisel + runtime/). You appear to be running from source or an npm install — install globally " +
-      "with your package manager there instead.",
-    )
-  }
-
-  const companions = [exeName, chiselName, "runtime", "README.txt"].filter(f => existsSync(join(bundle, f)))
-  if (isWin) return installWindows(args, bundle, companions)
-  return installUnix(args, bundle, companions)
-}
+type InstallOptions = { modifyPath: boolean, system: boolean, dir?: string, bin?: string }
 
 /** Copy the bundle's companion files into `target` (skipping the copy when target IS the bundle). */
 const copyBundle = (bundle: string, target: string, companions: string[]): void => {
@@ -79,29 +59,6 @@ const permError = (e: unknown, dir: string, system: boolean): CliError => {
   return new CliError(`Install failed: ${e instanceof Error ? e.message : String(e)}`)
 }
 
-const installUnix = (args: Args, bundle: string, companions: string[]): void => {
-  const system = flagBool(args, "system")
-  const libDir = resolve(flagStr(args, "dir") ?? (system ? "/usr/local/lib/lecodes-cli" : join(HOME, ".local", "lib", "lecodes-cli")))
-  const binDir = resolve(flagStr(args, "bin") ?? (system ? "/usr/local/bin" : join(HOME, ".local", "bin")))
-  const link = join(binDir, "lecodes")
-
-  try {
-    copyBundle(bundle, libDir, companions)
-    chmodSync(join(libDir, "lecodes"), 0o755)
-    chmodSync(join(libDir, "chisel"), 0o755)
-  } catch (e) { throw permError(e, libDir, system) }
-
-  try {
-    mkdirSync(binDir, { recursive: true })
-    rmSync(link, { force: true })                            // replace a previous symlink/file
-    symlinkSync(join(libDir, "lecodes"), link)
-  } catch (e) { throw permError(e, binDir, system) }
-
-  success(`Installed to ${c.bold(libDir)}`)
-  log(`  ${c.dim(link + " → " + join(libDir, "lecodes"))}`)
-  finishPathUnix(args, binDir)
-}
-
 /** The shell startup file to persist PATH into, picked from $SHELL (bash/zsh handled; else ~/.profile,
  *  which login shells read). Returns the absolute path and a ~-collapsed display name. */
 const shellRc = (): { file: string, name: string } => {
@@ -127,12 +84,12 @@ const appendPathToShellRc = (binDir: string): string | null => {
 }
 
 /** Put `binDir` on PATH: verify (already there), or `--modify-path` (edit the rc), or print how. */
-const finishPathUnix = (args: Args, binDir: string): void => {
+const finishPathUnix = (modifyPath: boolean, binDir: string): void => {
   if (onPath(binDir)) {
     log(`  Run ${c.bold("lecodes --version")} in a new shell to verify.`)
     return
   }
-  if (flagBool(args, "modify-path")) {
+  if (modifyPath) {
     const rc = appendPathToShellRc(binDir)
     if (rc) {
       success(`Added ${c.bold(binDir)} to PATH in ${rc}.`)
@@ -151,8 +108,46 @@ const finishPathUnix = (args: Args, binDir: string): void => {
   log(`  • or install system-wide (no PATH edit): ${c.bold("sudo lecodes install --system")}`)
 }
 
-const installWindows = (args: Args, bundle: string, companions: string[]): void => {
-  const target = resolve(flagStr(args, "dir") ?? join(process.env.LOCALAPPDATA ?? join(HOME, "AppData", "Local"), "Programs", "lecodes-cli"))
+const installUnix = (opts: InstallOptions, bundle: string, companions: string[]): void => {
+  const { system } = opts
+  const libDir = resolve(opts.dir ?? (system ? "/usr/local/lib/lecodes-cli" : join(HOME, ".local", "lib", "lecodes-cli")))
+  const binDir = resolve(opts.bin ?? (system ? "/usr/local/bin" : join(HOME, ".local", "bin")))
+  const link = join(binDir, "lecodes")
+
+  try {
+    copyBundle(bundle, libDir, companions)
+    chmodSync(join(libDir, "lecodes"), 0o755)
+    chmodSync(join(libDir, "chisel"), 0o755)
+  } catch (e) { throw permError(e, libDir, system) }
+
+  try {
+    mkdirSync(binDir, { recursive: true })
+    rmSync(link, { force: true })                            // replace a previous symlink/file
+    symlinkSync(join(libDir, "lecodes"), link)
+  } catch (e) { throw permError(e, binDir, system) }
+
+  success(`Installed to ${c.bold(libDir)}`)
+  log(`  ${c.dim(link + " → " + join(libDir, "lecodes"))}`)
+  finishPathUnix(opts.modifyPath, binDir)
+}
+
+/** Append `dir` to the current user's Path via the .NET env API (PowerShell). Unlike `setx` this never
+ *  truncates a long Path. The dir is passed through an env var to avoid any quoting/injection. */
+const addToUserPathWindows = (dir: string): boolean => {
+  const script =
+    "$d = $env:LECODES_INSTALL_DIR;" +
+    "$p = [Environment]::GetEnvironmentVariable('Path','User'); if (-not $p) { $p = '' };" +
+    "$parts = @($p.Split(';') | Where-Object { $_ -ne '' });" +
+    "if ($parts -notcontains $d) { [Environment]::SetEnvironmentVariable('Path', (@($parts + $d) -join ';'), 'User') }"
+  try {
+    execFileSync("powershell", ["-NoProfile", "-NonInteractive", "-Command", script],
+      { stdio: "ignore", env: { ...process.env, LECODES_INSTALL_DIR: dir } })
+    return true
+  } catch { return false }
+}
+
+const installWindows = (opts: InstallOptions, bundle: string, companions: string[]): void => {
+  const target = resolve(opts.dir ?? join(process.env.LOCALAPPDATA ?? join(HOME, "AppData", "Local"), "Programs", "lecodes-cli"))
 
   try {
     copyBundle(bundle, target, companions)
@@ -167,7 +162,7 @@ const installWindows = (args: Args, bundle: string, companions: string[]): void
     log(`  Already on PATH — run ${c.bold("lecodes --version")} in a new terminal.`)
     return
   }
-  if (flagBool(args, "modify-path")) {
+  if (opts.modifyPath) {
     if (addToUserPathWindows(target)) {
       success(`Added ${c.bold(target)} to your user PATH.`)
       log(`  ${c.yellow("Open a NEW terminal")} for it to take effect, then run ${c.bold("lecodes --version")}.`)
@@ -182,17 +177,35 @@ const installWindows = (args: Args, bundle: string, companions: string[]): void
   log(`  • or add the folder manually via System → Environment Variables.`)
 }
 
-/** Append `dir` to the current user's Path via the .NET env API (PowerShell). Unlike `setx` this never
- *  truncates a long Path. The dir is passed through an env var to avoid any quoting/injection. */
-const addToUserPathWindows = (dir: string): boolean => {
-  const script =
-    "$d = $env:LECODES_INSTALL_DIR;" +
-    "$p = [Environment]::GetEnvironmentVariable('Path','User'); if (-not $p) { $p = '' };" +
-    "$parts = @($p.Split(';') | Where-Object { $_ -ne '' });" +
-    "if ($parts -notcontains $d) { [Environment]::SetEnvironmentVariable('Path', (@($parts + $d) -join ';'), 'User') }"
-  try {
-    execFileSync("powershell", ["-NoProfile", "-NonInteractive", "-Command", script],
-      { stdio: "ignore", env: { ...process.env, LECODES_INSTALL_DIR: dir } })
-    return true
-  } catch { return false }
-}
+export default defineCommand({
+  name: "install",
+  summary: "Install this standalone build so `lecodes` is on your PATH",
+  description: "Copies the bundle (lecodes + chisel + runtime/) to a library folder and exposes the binary: a symlink in ~/.local/bin on Linux/macOS, the install folder itself on PATH on Windows. PATH is only edited with --modify-path; otherwise the command prints how to finish. Only works from the packaged release archive.",
+  flags: {
+    "modify-path": bool("also add it to PATH (edits your shell rc / user PATH)"),
+    system: bool("install for all users (Linux/macOS; needs sudo)"),
+    dir: str("override the install/library folder", { value: "<path>" }),
+    bin: str("override the symlink folder (Linux/macOS)", { value: "<path>" }),
+  },
+  examples: ["lecodes install --modify-path", "sudo lecodes install --system"],
+  run: ({ flags }) => {
+    const bundle = dirname(process.execPath)
+    const exeName = basename(process.execPath)               // "lecodes" | "lecodes.exe"
+    const chiselName = isWin ? "chisel.exe" : "chisel"
+
+    // Guard: this must be the packaged standalone bundle (chisel + runtime/ sit next to the binary).
+    // From npm / the monorepo, process.execPath is the bun/node binary and has no companions.
+    if (!existsSync(join(bundle, "runtime")) || !existsSync(join(bundle, chiselName))) {
+      throw new CliError(
+        "`lecodes install` only works from the packaged release build (the archive containing lecodes + " +
+        "chisel + runtime/). You appear to be running from source or an npm install — install globally " +
+        "with your package manager there instead.",
+      )
+    }
+
+    const companions = [exeName, chiselName, "runtime", "README.txt"].filter(f => existsSync(join(bundle, f)))
+    const opts: InstallOptions = { modifyPath: flags["modify-path"], system: flags.system, dir: flags.dir, bin: flags.bin }
+    if (isWin) return installWindows(opts, bundle, companions)
+    return installUnix(opts, bundle, companions)
+  },
+})