@gunshi/plugin-completion 0.31.0 → 0.32.0

package/README.md

@@ -13,7 +13,7 @@ This completion plugin is powered by [`@bomb.sh/tab`](https://github.com/bombshe
 <!-- eslint-disable markdown/no-missing-label-refs -->
 
 > [!WARNING]
-> This package support Node.js runtime only. Deno and Bun support are coming soon.
+> This package supports Node.js and Bun runtimes only. Deno support is not available yet.
 
 <!-- eslint-enable markdown/no-missing-label-refs -->
 
@@ -122,14 +122,8 @@ This section provides detailed instructions for setting up shell completions in
 
 ### Prerequisites
 
-Shell completion requires Node.js runtime. Ensure your CLI is running with Node.js (not Deno or Bun).
-
-<!-- eslint-disable markdown/no-missing-label-refs -->
-
-> [!WARNING]
-> This package support Node.js runtime only. Deno and Bun support are coming soon.
-
-<!-- eslint-enable markdown/no-missing-label-refs -->
+Shell completion requires your CLI command to be executable from the generated completion script.
+The plugin currently supports completion script generation for Node.js, Bun source execution, and Bun single-file executables.
 
 ### Setup by Shell
 

package/lib/index.js

@@ -266,14 +266,126 @@ const pluginId = namespacedId("completion");
 * @author kazuya kawaguchi (a.k.a. kazupon)
 * @license MIT
 */
+function getRuntimeGlobals() {
+	return globalThis;
+}
+/**
+* Detect the active JavaScript runtime.
+*
+* @returns The detected runtime name
+*/
 function detectRuntime() {
-	if (globalThis.process !== void 0 && globalThis.process.release?.name === "node") return "node";
-	if (globalThis.Deno !== void 0) return "deno";
-	if (globalThis.Bun !== void 0) return "bun";
+	return detectRuntimeFromGlobals(getRuntimeGlobals());
+}
+/**
+* Detect the active JavaScript runtime from globals.
+*
+* @param globals - Runtime globals to inspect
+* @returns The detected runtime name
+*/
+function detectRuntimeFromGlobals(globals) {
+	if (globals.Bun !== void 0) return "bun";
+	if (globals.Deno !== void 0) return "deno";
+	if (globals.process !== void 0 && globals.process.release?.name === "node") return "node";
 	return "unknown";
 }
-function quoteIfNeeded(path) {
-	return path.includes(" ") ? `'${path}'` : path;
+/**
+* Quote a shell command part when needed.
+*
+* This protects the command part when the generated completion script later
+* evaluates the assembled command string. Callers that embed the quoted result
+* into another shell string still need to escape that outer string.
+*
+* @param value - The command part to quote
+* @returns The shell-safe command part
+*/
+function shellQuote(value) {
+	if (value.length === 0) return "''";
+	if (/^[\w%+,./:=@-]+$/.test(value)) return value;
+	return `'${value.replaceAll(`'`, `'\\''`)}'`;
+}
+function escapeDoubleQuotedShellString(value) {
+	return value.replaceAll(/[$`"\\]/g, "\\$&");
+}
+function basename(path) {
+	const slash = path.lastIndexOf("/");
+	const backslash = path.lastIndexOf("\\");
+	return path.slice(Math.max(slash, backslash) + 1);
+}
+/**
+* Check if the entry is a Bun virtual entry.
+*
+* @param entry - The entry to check
+* @returns Whether the entry is a Bun virtual entry
+*
+* Bun compiled executables may surface internal virtual paths in `process.argv`
+* instead of the original source entry. These markers are intentionally private
+* to keep the single-binary check heuristic rather than a public contract.
+*
+* @see https://github.com/oven-sh/bun/blob/main/src/standalone_graph/StandaloneModuleGraph.rs#L44-L70
+* @see https://github.com/oven-sh/bun/blob/main/test/regression/issue/22157.test.ts#L47-L55
+*/
+function isBunVirtualEntry(entry) {
+	return entry?.startsWith("/$bunfs/") === true || entry?.startsWith("B:\\~BUN\\") === true || entry?.startsWith("B:/~BUN/") === true;
+}
+/**
+* Check if the executable is a likely Bun single binary.
+*
+* @param execPath - The executable path
+* @param entry - The entry to check
+* @returns Whether the executable is a likely Bun single binary
+*
+* Bun documents `bun build --compile` as producing a single-file executable,
+* but it does not expose a stable "compiled executable" runtime flag.
+* Prefer calling the current executable when `process.execPath` is no longer
+* the Bun launcher, because the shell completion script needs to re-enter the
+* compiled CLI rather than the original source file.
+*
+* @see https://bun.com/docs/bundler/executables
+* @see https://github.com/oven-sh/bun/issues/14676
+*/
+function isLikelyBunSingleBinary(execPath, entry) {
+	const name = basename(execPath).toLowerCase();
+	if (name !== "bun" && name !== "bun.exe") return true;
+	return isBunVirtualEntry(entry);
+}
+/**
+* Resolve executable command parts for Node.js source execution.
+*
+* @param process - Node-compatible process global
+* @returns Executable command parts
+*/
+function resolveNodeExecParts(process) {
+	const entry = process.argv[1];
+	return [
+		process.execPath,
+		...process.execArgv ?? [],
+		...entry ? [entry] : []
+	];
+}
+/**
+* Resolve executable command parts for Bun source and compiled execution.
+*
+* @param process - Bun process global
+* @returns Executable command parts
+*/
+function resolveBunExecParts(process) {
+	const entry = process.argv[1];
+	if (isLikelyBunSingleBinary(process.execPath, entry)) return [process.execPath];
+	return [
+		process.execPath,
+		...process.execArgv ?? [],
+		...entry ? [entry] : []
+	];
+}
+/**
+* Join executable command parts into a shell-safe command string.
+*
+* @param parts - Executable command parts
+* @returns The executable command string
+*/
+function joinExecParts(parts) {
+	return escapeDoubleQuotedShellString(parts.map(shellQuote).join(" "));
 }
 /**
 * Quote the exec command for the current runtime.
@@ -281,17 +393,12 @@ function quoteIfNeeded(path) {
 * @returns The quoted exec command string
 */
 function quoteExec() {
+	const globals = getRuntimeGlobals();
 	switch (detectRuntime()) {
-		case "node": {
-			const execPath = globalThis.process.execPath;
-			const processArgs = globalThis.process.argv.slice(1);
-			const quotedExecPath = quoteIfNeeded(execPath);
-			const quotedProcessArgs = processArgs.map(quoteIfNeeded);
-			return `${quotedExecPath} ${globalThis.process.execArgv.map(quoteIfNeeded).join(" ")} ${quotedProcessArgs[0]}`;
-		}
-		case "deno": throw new Error("deno not implemented yet, welcome contributions :)");
-		case "bun": throw new Error("bun not implemented yet, welcome contributions :)");
-		default: throw new Error("Unsupported your javascript runtime for completion script generation.");
+		case "node": return joinExecParts(resolveNodeExecParts(globals.process));
+		case "deno": throw new Error("Deno runtime is not supported for completion script generation yet.");
+		case "bun": return joinExecParts(resolveBunExecParts(globals.process));
+		default: throw new Error("Unsupported JavaScript runtime for completion script generation.");
 	}
 }
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/plugin-completion",
   "description": "completion plugin for gunshi",
-  "version": "0.31.0",
+  "version": "0.32.0",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -53,10 +53,10 @@
   },
   "dependencies": {
     "@bomb.sh/tab": "^0.0.15",
-    "@gunshi/plugin": "0.31.0"
+    "@gunshi/plugin": "0.32.0"
   },
   "peerDependencies": {
-    "@gunshi/plugin-i18n": "0.31.0"
+    "@gunshi/plugin-i18n": "0.32.0"
   },
   "devDependencies": {
     "@types/node": "^25.6.2",
@@ -68,8 +68,8 @@
     "tsdown": "0.21.0",
     "typedoc": "^0.28.19",
     "typedoc-plugin-markdown": "^4.11.0",
-    "@gunshi/shared": "0.31.0",
-    "@gunshi/plugin-i18n": "0.31.0"
+    "@gunshi/plugin-i18n": "0.32.0",
+    "@gunshi/shared": "0.32.0"
   },
   "scripts": {
     "build": "tsdown",