@clerc/plugin-completions 0.40.0 → 0.41.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Ray <https://github.com/so1ve>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Ray <https://github.com/so1ve>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+# @clerc/plugin-completions
+
+[![NPM version](https://img.shields.io/npm/v/@clerc/plugin-completions?color=a1b858&label=)](https://www.npmjs.com/package/@clerc/plugin-completions)
+
+Clerc plugin to add shell completions to your cli.
+
+## 📦 Installation
+
+```bash
+$ npm install @clerc/plugin-completions
+$ yarn add @clerc/plugin-completions
+$ pnpm add @clerc/plugin-completions
+```
+
+## 🚀 Usage
+
+```ts
+import { completionsPlugin } from "@clerc/plugin-completions";
+
+cli.use(completionsPlugin());
+```
+
+## 📝 License
+
+[MIT](../../LICENSE). Made with ❤️ by [Ray](https://github.com/so1ve)

package/dist/index.js

@@ -1,7 +1,14 @@
-import{definePlugin as p}from"@clerc/core";const c=e=>`
-            ${e})
-                cmd+="__${e}"
-                ;;`,$=e=>{const{cli:o}=e,{_scriptName:t,_commands:n}=o;return`_${t}() {
+import { definePlugin } from '@clerc/core';
+import { gracefulFlagName, kebabCase } from '@clerc/utils';
+
+const generateCommandCompletion = (name) => `
+            ${name})
+                cmd+="__${name}"
+                ;;`;
+function getBashCompletion(ctx) {
+  const { cli } = ctx;
+  const { _scriptName: name, _commands: commands } = cli;
+  return `_${name}() {
     local i cur prev opts cmds
     COMPREPLY=()
     cur="\${COMP_WORDS[COMP_CWORD]}"
@@ -13,27 +20,49 @@ import{definePlugin as p}from"@clerc/core";const c=e=>`
     do
         case "\${i}" in
             "$1")
-                cmd="${t}"
+                cmd="${name}"
                 ;;
-${Object.keys(n).map(c).join("")}
+${Object.keys(commands).map(generateCommandCompletion).join("")}
             *)
                 ;;
         esac
     done
 }
 
-complete -F _${t} -o bashdefault -o default ${t}
-`},i=e=>e.replace(/([A-Z])/g,(o,t)=>`-${t.toLowerCase()}`),r=e=>e.length<=1?`-${e}`:`--${i(e)}`,a="(No Description)",u=e=>`[CompletionResult]::new('${e.name}', '${e.name}', [CompletionResultType]::ParameterValue, '${e.description}')`,d=e=>{var o;return Object.entries((o=e.flags)!=null?o:{}).map(([t,n])=>{const s=[`[CompletionResult]::new('${r(t)}', '${i(t)}', [CompletionResultType]::ParameterName, '${e.flags[t].description||a}')`];return n!=null&&n.alias&&s.push(`[CompletionResult]::new('${r(n.alias)}', '${n.alias}', [CompletionResultType]::ParameterName, '${e.flags[t].description||a}')`),s.join(`
-            `)}).join(`
-            `)},C=e=>{const{cli:o}=e,{_scriptName:t,_commands:n}=o;return`using namespace System.Management.Automation
+complete -F _${name} -o bashdefault -o default ${name}
+`;
+}
+
+const NO_DESCRIPTION = "(No Description)";
+const getCompletionValue = (command) => `[CompletionResult]::new('${command.name}', '${command.name}', [CompletionResultType]::ParameterValue, '${command.description}')`;
+const getCompletionFlag = (command) => {
+  var _a;
+  return Object.entries((_a = command.flags) != null ? _a : {}).map(([flagName, flag]) => {
+    const gen = [
+      `[CompletionResult]::new('${gracefulFlagName(flagName)}', '${kebabCase(
+        flagName
+      )}', [CompletionResultType]::ParameterName, '${command.flags[flagName].description || NO_DESCRIPTION}')`
+    ];
+    if (flag == null ? void 0 : flag.alias) {
+      gen.push(
+        `[CompletionResult]::new('${gracefulFlagName(flag.alias)}', '${flag.alias}', [CompletionResultType]::ParameterName, '${command.flags[flagName].description || NO_DESCRIPTION}')`
+      );
+    }
+    return gen.join("\n            ");
+  }).join("\n            ");
+};
+function getPwshCompletion(ctx) {
+  const { cli } = ctx;
+  const { _scriptName: name, _commands: commands } = cli;
+  return `using namespace System.Management.Automation
 using namespace System.Management.Automation.Language
 
-Register-ArgumentCompleter -Native -CommandName '${t}' -ScriptBlock {
+Register-ArgumentCompleter -Native -CommandName '${name}' -ScriptBlock {
     param($wordToComplete, $commandAst, $cursorPosition)
 
     $commandElements = $commandAst.CommandElements
     $command = @(
-        '${t}'
+        '${name}'
         for ($i = 1; $i -lt $commandElements.Count; $i++) {
             $element = $commandElements[$i]
             if ($element -isnot [StringConstantExpressionAst] -or
@@ -46,18 +75,60 @@ Register-ArgumentCompleter -Native -CommandName '${t}' -ScriptBlock {
     }) -join ';'
 
     $completions = @(switch ($command) {
-        '${t}' {
-            ${Object.entries(n).map(([s,m])=>u(m)).join(`
-            `)}
+        '${name}' {
+            ${Object.entries(commands).map(([_, command]) => getCompletionValue(command)).join("\n            ")}
             break
         }
-        ${Object.entries(n).map(([s,m])=>`'${t};${s.split(" ").join(";")}' {
-            ${d(m)}
+        ${Object.entries(commands).map(
+    ([commandName, command]) => `'${name};${commandName.split(" ").join(";")}' {
+            ${getCompletionFlag(command)}
             break
-        }`).join(`
-        `)}
+        }`
+  ).join("\n        ")}
     })
 
     $completions.Where{ $_.CompletionText -like "$wordToComplete*" } |
         Sort-Object -Property ListItemText
-}`},l={bash:$,pwsh:C},g=(e={})=>p({setup:o=>{const{command:t=!0}=e;return t&&(o=o.command("completions","Print shell completions to stdout",{flags:{shell:{description:"Shell type",type:String,default:""}},parameters:["[shell]"]}).on("completions",n=>{var s;if(!o._scriptName)throw new Error("CLI name is not defined!");const m=String((s=n.parameters.shell)!=null?s:n.flags.shell);if(!m)throw new Error("Missing shell name");if(m in l)process.stdout.write(l[m](n));else throw new Error(`No such shell: ${m}`)})),o}});export{g as completionsPlugin};
+}`;
+}
+
+const completionMap = {
+  bash: getBashCompletion,
+  pwsh: getPwshCompletion
+};
+const completionsPlugin = (options = {}) => definePlugin({
+  setup: (cli) => {
+    const { command = true } = options;
+    if (command) {
+      cli = cli.command("completions", "Print shell completions to stdout", {
+        flags: {
+          shell: {
+            description: "Shell type",
+            type: String,
+            default: ""
+          }
+        },
+        parameters: ["[shell]"]
+      }).on("completions", (ctx) => {
+        var _a;
+        if (!cli._scriptName) {
+          throw new Error("CLI name is not defined!");
+        }
+        const shell = String((_a = ctx.parameters.shell) != null ? _a : ctx.flags.shell);
+        if (!shell) {
+          throw new Error("Missing shell name");
+        }
+        if (shell in completionMap) {
+          process.stdout.write(
+            completionMap[shell](ctx)
+          );
+        } else {
+          throw new Error(`No such shell: ${shell}`);
+        }
+      });
+    }
+    return cli;
+  }
+});
+
+export { completionsPlugin };

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@clerc/plugin-completions",
-  "version": "0.40.0",
+  "version": "0.41.0",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
+  "type": "module",
   "description": "Clerc plugin completions",
   "keywords": [
-    "cli",
-    "clerc",
-    "clerc-plugin",
+    "args",
     "arguments",
     "argv",
-    "args",
+    "clerc",
+    "clerc-plugin",
+    "cli",
     "terminal"
   ],
-  "type": "module",
   "homepage": "https://github.com/so1ve/clerc/tree/main/packages/plugin-completions#readme",
   "repository": {
     "type": "git",
@@ -47,15 +47,14 @@
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "@clerc/utils": "0.41.0"
+  },
   "peerDependencies": {
     "@clerc/core": "*"
   },
-  "devDependencies": {
-    "@clerc/core": "0.40.0",
-    "@clerc/utils": "0.40.0"
-  },
   "scripts": {
-    "build": "pkgroll --minify",
+    "build": "pkgroll",
     "watch": "pkgroll --watch"
   }
 }