@clerc/plugin-completions 1.0.0-beta.8 → 1.0.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { ArgumentHandler, Command, OptionHandler } from "@bomb.sh/tab";
 import { Plugin } from "@clerc/core";
 
 //#region src/index.d.ts
@@ -13,16 +14,41 @@ declare module "@clerc/core" {
       * @default true
       */
       show?: boolean;
+      /**
+      * Handler to provide custom completions for the command.
+      */
+      handler?: (command: Command) => void;
+    };
+  }
+  interface FlagCustomOptions {
+    /**
+    * Completions options for the flag.
+    */
+    completions?: {
+      /**
+      * Whether to show the flag in completions output.
+      *
+      * @default true
+      */
+      show?: boolean;
+      /**
+      * Handler to provide custom completions for the flag.
+      */
+      handler?: OptionHandler;
+    };
+  }
+  interface ParameterCustomOptions {
+    /**
+    * Completions options for the parameter.
+    */
+    completions?: {
+      /**
+      * Handler to provide custom completions for the parameter.
+      */
+      handler?: ArgumentHandler;
     };
   }
 }
-interface CompletionsPluginOptions {
-  /**
-  * Whether to register the `completions install` and `completions uninstall` commands.
-  * @default true
-  */
-  managementCommands?: boolean;
-}
-declare const completionsPlugin: (options?: CompletionsPluginOptions) => Plugin;
+declare const completionsPlugin: () => Plugin;
 //#endregion
-export { CompletionsPluginOptions, completionsPlugin };
+export { completionsPlugin };

package/dist/index.js

@@ -1,133 +1,67 @@
-import { DOUBLE_DASH, definePlugin, resolveCommand } from "@clerc/core";
-import tabtab, { getShellFromEnv } from "@pnpm/tabtab";
-import { formatFlagName, toArray } from "@clerc/utils";
+import { RootCommand } from "@bomb.sh/tab";
+import { Types, definePlugin, extractParameterInfo, normalizeFlagValue, normalizeParameterValue } from "@clerc/core";
 
-//#region src/complete.ts
-function splitCommand(cmd) {
-	const args = [];
-	let current = "";
-	let quote = null;
-	let escape = false;
-	for (const char of cmd) {
-		if (escape) {
-			current += char;
-			escape = false;
-			continue;
-		}
-		if (char === "\\") {
-			escape = true;
-			continue;
-		}
-		if (quote) if (char === quote) quote = null;
-		else current += char;
-		else if (char === "\"" || char === "'") quote = char;
-		else if (/\s/.test(char)) {
-			if (current) {
-				args.push(current);
-				current = "";
-			}
-		} else current += char;
+//#region src/t.ts
+function registerFlag(tc, flagName, def) {
+	const normalized = normalizeFlagValue(def);
+	const desc = normalized.description ?? "";
+	if (normalized.type === Boolean) tc.option(flagName, desc, normalized.short);
+	else {
+		const handler = normalized.completions?.handler ?? (async () => {});
+		tc.option(flagName, desc, handler, normalized.short);
 	}
-	if (current) args.push(current);
-	return args;
 }
-async function getCompletion(cli, env) {
-	const inputArgv = splitCommand(env.partial.slice(0, env.partial.length - env.lastPartial.length)).slice(1);
-	if (inputArgv.includes(DOUBLE_DASH)) return [];
-	const [command, commandName] = resolveCommand(cli._commands, inputArgv);
-	if (env.lastPartial.startsWith("-")) {
-		const flags = command ? {
-			...cli._globalFlags,
-			...command.flags
-		} : cli._globalFlags;
-		const candidates$1 = [];
-		for (const [name, def] of Object.entries(flags)) {
-			candidates$1.push({
-				name: formatFlagName(name),
-				description: def.description
-			});
-			if (def.alias) {
-				const aliases = toArray(def.alias);
-				for (const alias of aliases) candidates$1.push({
-					name: formatFlagName(alias),
-					description: def.description
-				});
-			}
+function registerGlobalFlags(globalFlags, tc) {
+	for (const [flagName, def] of Object.entries(globalFlags)) registerFlag(tc, flagName, def);
+}
+function buildTabModel(t, globalFlags, commands) {
+	registerGlobalFlags(globalFlags, t);
+	for (const cmd of commands.values()) {
+		if (cmd.completions?.show === false) continue;
+		let command = t;
+		if (cmd.name !== "") {
+			command = t.command(cmd.name, cmd.description ?? "");
+			registerGlobalFlags(globalFlags, command);
 		}
-		return candidates$1;
-	}
-	const candidates = [];
-	let prefix = "";
-	if (commandName) {
-		const matchedParts = commandName.split(" ");
-		const remainingArgs = inputArgv.slice(matchedParts.length);
-		prefix = `${[command.name, ...remainingArgs].join(" ")} `;
-	} else prefix = inputArgv.length > 0 ? `${inputArgv.join(" ")} ` : "";
-	for (const command$1 of cli._commands.values()) {
-		if (command$1.completions?.show === false) continue;
-		if (command$1.name.startsWith(prefix)) {
-			const nextWord = command$1.name.slice(prefix.length).split(" ")[0];
-			if (nextWord) candidates.push({
-				name: nextWord,
-				description: command$1.description
-			});
+		cmd.completions?.handler?.(command);
+		for (const def of cmd.parameters ?? []) {
+			const normalized = normalizeParameterValue(def);
+			const { name, isVariadic } = extractParameterInfo(normalized.key);
+			command.argument(name, normalized.completions?.handler, isVariadic);
 		}
+		for (const [flagName, def] of Object.entries(cmd.flags ?? {})) registerFlag(command, flagName, def);
 	}
-	const uniqueCandidates = /* @__PURE__ */ new Map();
-	for (const c of candidates) uniqueCandidates.set(c.name, c);
-	return [...uniqueCandidates.values()];
 }
 
 //#endregion
 //#region src/index.ts
-const completionsPlugin = (options = {}) => definePlugin({ setup: (cli) => {
-	const { managementCommands = true } = options;
-	if (managementCommands) {
-		cli.command("completions install", "Install shell completions", {
-			help: { group: "completions" },
-			flags: { shell: {
-				description: "Shell type",
-				type: String
-			} },
-			parameters: ["[shell]"]
-		}).on("completions install", async (ctx) => {
-			const shell = ctx.parameters.shell ?? ctx.flags.shell;
-			if (!shell) throw new Error("Please specify the shell type via the --shell flag or the [shell] parameter.");
-			if (!tabtab.SUPPORTED_SHELLS.includes(shell)) throw new Error(`Unsupported shell: ${shell}. Supported shells are: ${tabtab.SUPPORTED_SHELLS.join(", ")}.`);
-			await tabtab.install({
-				name: cli._name,
-				completer: cli._name,
-				shell
-			});
-		});
-		cli.command("completions uninstall", "Uninstall shell completions", { help: { group: "completions" } }).on("completions uninstall", async () => {
-			await tabtab.uninstall({ name: cli._name });
-		});
-	}
-	cli.command("completions", "Generate completions script", {
-		help: { group: "completions" },
+const completionsPlugin = () => definePlugin({ setup: (cli) => {
+	const t = new RootCommand();
+	const supportedShellEnum = Types.Enum("zsh", "bash", "fish", "powershell");
+	cli.command("completions", "Generate shell completion scripts", {
 		flags: { shell: {
 			description: "Shell type",
-			type: String
+			type: supportedShellEnum
 		} },
-		parameters: ["[shell]"]
+		parameters: [{
+			key: "[shell]",
+			description: "Shell type",
+			type: supportedShellEnum
+		}]
 	}).on("completions", async (ctx) => {
 		const shell = ctx.parameters.shell ?? ctx.flags.shell;
-		if (!shell) throw new Error("Please specify the shell type via the --shell flag or the [shell] parameter.");
-		if (!tabtab.SUPPORTED_SHELLS.includes(shell)) throw new Error(`Unsupported shell: ${shell}. Supported shells are: ${tabtab.SUPPORTED_SHELLS.join(", ")}.`);
-		const script = await tabtab.getCompletionScript({
-			name: cli._name,
-			completer: cli._name,
-			shell
-		});
-		console.log(script);
+		if (!shell) throw new Error("Shell type is required. Please provide it via --shell flag or [shell] parameter.");
+		buildTabModel(t, cli._globalFlags, cli._commands);
+		t.setup(cli._scriptName, cli._scriptName, shell);
 	});
-	cli.command("completion-server", "Handle completions", { help: { show: false } }).on("completion-server", async () => {
-		const env = tabtab.parseEnv(process.env);
-		if (!env.complete) return;
-		const shell = getShellFromEnv(process.env);
-		const filtered = (await getCompletion(cli, env)).filter((c) => c.name.startsWith(env.lastPartial));
-		tabtab.log(filtered, shell);
+	cli.command("complete", {
+		help: { show: false },
+		completions: { show: false },
+		parameters: ["--", "[input...]"]
+	}).on("complete", async (ctx) => {
+		buildTabModel(t, cli._globalFlags, cli._commands);
+		const { input } = ctx.parameters;
+		t.parse(input);
 	});
 	return cli;
 } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/plugin-completions",
-  "version": "1.0.0-beta.8",
+  "version": "1.0.0",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc plugin completions",
@@ -27,6 +27,9 @@
   "exports": {
     ".": "./dist/index.js"
   },
+  "bin": {
+    "my-cli": "./src/a.mjs"
+  },
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "dist/index.d.ts",
@@ -45,17 +48,13 @@
     "access": "public"
   },
   "dependencies": {
-    "@pnpm/tabtab": "^0.5.4",
-    "@clerc/utils": "1.0.0-beta.8"
+    "@bomb.sh/tab": "^0.0.10"
   },
   "devDependencies": {
-    "@clerc/core": "1.0.0-beta.8"
+    "@clerc/core": "1.0.0",
+    "@clerc/utils": "1.0.0"
   },
   "peerDependencies": {
     "@clerc/core": "*"
-  },
-  "scripts": {
-    "build": "tsdown",
-    "watch": "tsdown --watch"
   }
 }