@clerc/plugin-completions 1.0.0-beta.17 → 1.0.0-beta.18

package/dist/index.js

@@ -1,4 +1,4 @@
-import { DOUBLE_DASH, definePlugin, resolveCommand } from "@clerc/core";
+import { DOUBLE_DASH, Types, definePlugin, normalizeFlagValue, resolveCommand } from "@clerc/core";
 import tabtab, { getShellFromEnv } from "@pnpm/tabtab";
 
 //#region ../utils/src/index.ts
@@ -47,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
 				});
 			}
 		}
@@ -87,42 +88,52 @@ 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", { help: { group: "completions" } }).on("completions uninstall", async () => {
-			await tabtab.uninstall({ name: cli._name });
+			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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/plugin-completions",
-  "version": "1.0.0-beta.17",
+  "version": "1.0.0-beta.18",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc plugin completions",
@@ -48,8 +48,8 @@
     "@pnpm/tabtab": "^0.5.4"
   },
   "devDependencies": {
-    "@clerc/core": "1.0.0-beta.17",
-    "@clerc/utils": "1.0.0-beta.17"
+    "@clerc/core": "1.0.0-beta.18",
+    "@clerc/utils": "1.0.0-beta.18"
   },
   "peerDependencies": {
     "@clerc/core": "*"