@clerc/plugin-completions 1.0.0-beta.2 → 1.0.0-beta.20

package/dist/index.d.ts

@@ -1,6 +1,21 @@
 import { Plugin } from "@clerc/core";
 
 //#region src/index.d.ts
+declare module "@clerc/core" {
+  interface CommandCustomOptions {
+    /**
+    * Completions options for the command.
+    */
+    completions?: {
+      /**
+      * Whether to show the command in completions output.
+      *
+      * @default true
+      */
+      show?: boolean;
+    };
+  }
+}
 interface CompletionsPluginOptions {
   /**
   * Whether to register the `completions install` and `completions uninstall` commands.

package/dist/index.js

@@ -1,7 +1,12 @@
-import { definePlugin, resolveCommand } from "@clerc/core";
+import { DOUBLE_DASH, Types, definePlugin, normalizeFlagValue, resolveCommand } from "@clerc/core";
 import tabtab, { getShellFromEnv } from "@pnpm/tabtab";
-import { formatFlagName, toArray } from "@clerc/utils";
 
+//#region ../utils/src/index.ts
+const toArray = (a) => Array.isArray(a) ? a : [a];
+const kebabCase = (s) => s.replace(/([A-Z])/g, (_, c) => `-${c.toLowerCase()}`);
+const formatFlagName = (n) => n.length <= 1 ? `-${n}` : `--${kebabCase(n)}`;
+
+//#endregion
 //#region src/complete.ts
 function splitCommand(cmd) {
 	const args = [];
@@ -33,7 +38,7 @@ function splitCommand(cmd) {
 }
 async function getCompletion(cli, env) {
 	const inputArgv = splitCommand(env.partial.slice(0, env.partial.length - env.lastPartial.length)).slice(1);
-	if (inputArgv.includes("--")) return [];
+	if (inputArgv.includes(DOUBLE_DASH)) return [];
 	const [command, commandName] = resolveCommand(cli._commands, inputArgv);
 	if (env.lastPartial.startsWith("-")) {
 		const flags = command ? {
@@ -42,15 +47,16 @@ async function getCompletion(cli, env) {
 		} : cli._globalFlags;
 		const candidates$1 = [];
 		for (const [name, def] of Object.entries(flags)) {
+			const normalized = normalizeFlagValue(def);
 			candidates$1.push({
 				name: formatFlagName(name),
-				description: def.description
+				description: normalized.description
 			});
-			if (def.alias) {
-				const aliases = toArray(def.alias);
+			if (normalized.alias) {
+				const aliases = toArray(normalized.alias);
 				for (const alias of aliases) candidates$1.push({
 					name: formatFlagName(alias),
-					description: def.description
+					description: normalized.description
 				});
 			}
 		}
@@ -63,12 +69,15 @@ async function getCompletion(cli, env) {
 		const remainingArgs = inputArgv.slice(matchedParts.length);
 		prefix = `${[command.name, ...remainingArgs].join(" ")} `;
 	} else prefix = inputArgv.length > 0 ? `${inputArgv.join(" ")} ` : "";
-	for (const c of cli._commands.values()) if (c.name.startsWith(prefix)) {
-		const nextWord = c.name.slice(prefix.length).split(" ")[0];
-		if (nextWord) candidates.push({
-			name: nextWord,
-			description: c.description
-		});
+	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
+			});
+		}
 	}
 	const uniqueCandidates = /* @__PURE__ */ new Map();
 	for (const c of candidates) uniqueCandidates.set(c.name, c);
@@ -79,45 +88,57 @@ async function getCompletion(cli, env) {
 //#region src/index.ts
 const completionsPlugin = (options = {}) => definePlugin({ setup: (cli) => {
 	const { managementCommands = true } = options;
+	cli.store.help?.addGroup({ commands: [["completions", "Completions"]] });
+	const supportedShellEnum = Types.Enum(...tabtab.SUPPORTED_SHELLS);
 	if (managementCommands) {
 		cli.command("completions install", "Install shell completions", {
+			help: { group: "completions" },
 			flags: { shell: {
 				description: "Shell type",
-				type: String
+				type: supportedShellEnum
 			} },
-			parameters: ["[shell]"]
+			parameters: [{
+				key: "[shell]",
+				description: "Shell type",
+				type: supportedShellEnum
+			}]
 		}).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,
+				name: cli._scriptName,
+				completer: cli._scriptName,
 				shell
 			});
 		});
-		cli.command("completions uninstall", "Uninstall shell completions").on("completions uninstall", async () => {
-			await tabtab.uninstall({ name: cli._name });
+		cli.command("completions uninstall", "Uninstall shell completions", { help: { group: "completions" } }).on("completions uninstall", async () => {
+			await tabtab.uninstall({ name: cli._scriptName });
 		});
 	}
 	cli.command("completions", "Generate completions script", {
+		help: { group: "completions" },
 		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,
+			name: cli._scriptName,
+			completer: cli._scriptName,
 			shell
 		});
 		console.log(script);
 	});
-	cli.command("completion-server", "Handle completions", { help: { showInHelp: false } }).on("completion-server", async () => {
+	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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/plugin-completions",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.20",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc plugin completions",
@@ -45,17 +45,13 @@
     "access": "public"
   },
   "dependencies": {
-    "@pnpm/tabtab": "^0.5.4",
-    "@clerc/utils": "1.0.0-beta.2"
+    "@pnpm/tabtab": "^0.5.4"
   },
   "devDependencies": {
-    "@clerc/core": "1.0.0-beta.2"
+    "@clerc/core": "1.0.0-beta.20",
+    "@clerc/utils": "1.0.0-beta.20"
   },
   "peerDependencies": {
     "@clerc/core": "*"
-  },
-  "scripts": {
-    "build": "tsdown",
-    "watch": "tsdown --watch"
   }
 }