easycli-autocomplete 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Avijit
+
+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,56 @@
+# @easycli/autocomplete
+
+Automatic shell completion generator for EasyCLI applications.
+
+## Features
+
+- **Multi-Shell Support**: Generates scripts for Bash, Zsh, and Fish.
+- **Context Aware**: Autocompletes commands, subcommands, and flags.
+- **Fast**: Static script generation for zero-latency completion.
+
+## Installation
+
+```bash
+pnpm add @easycli/autocomplete
+```
+
+## Usage
+
+```ts
+import { generateCompletion } from "@easycli/autocomplete";
+
+// Get your CLI config (usually from defineCLI)
+const config = {
+  name: "my-cli",
+  commands: { ... }
+};
+
+// Generate script for Bash
+const script = generateCompletion("bash", config);
+
+console.log(script);
+```
+
+## Integration
+
+Typically, you would add a `completion` command to your CLI:
+
+```ts
+import { defineCommand } from "@easycli/core";
+import { generateCompletion } from "@easycli/autocomplete";
+
+export const completion = defineCommand({
+  description: "Generate completion script",
+  args: {
+    shell: {
+        type: "enum",
+        values: ["bash", "zsh", "fish"]
+    }
+  },
+  run({ args, ctx }) {
+    // Assuming you have access to the full CLI config
+    const script = generateCompletion(args.shell, ctx.config);
+    console.log(script);
+  }
+});
+```

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+interface CommandDef {
+    description?: string;
+    commands?: Record<string, CommandDef>;
+    flags?: Record<string, {
+        alias?: string;
+        description?: string;
+    }>;
+}
+interface CLIConfig {
+    name: string;
+    commands: Record<string, CommandDef>;
+}
+/**
+ * Generates Bash completion script.
+ *
+ * @param config - The CLI configuration including commands.
+ * @returns The Bash completion script.
+ */
+declare function generateBashCompletion(config: CLIConfig): string;
+/**
+ * Generates Zsh completion script.
+ *
+ * @param config - The CLI configuration including commands.
+ * @returns The Zsh completion script.
+ */
+declare function generateZshCompletion(config: CLIConfig): string;
+/**
+ * Generates Fish completion script.
+ *
+ * @param config - The CLI configuration including commands.
+ * @returns The Fish completion script.
+ */
+declare function generateFishCompletion(config: CLIConfig): string;
+/**
+ * Supported shell types for autocomplete generation.
+ */
+type ShellType = "bash" | "zsh" | "fish";
+/**
+ * Generates an autocomplete script for the specified shell.
+ *
+ * @param shell - The target shell ("bash", "zsh", or "fish").
+ * @param config - The CLI configuration including commands.
+ * @returns The generated shell script as a string.
+ */
+declare function generateCompletion(shell: ShellType, config: CLIConfig): string;
+
+export { type ShellType, generateBashCompletion, generateCompletion, generateFishCompletion, generateZshCompletion };

package/dist/index.js

@@ -0,0 +1,105 @@
+// src/generator.ts
+function generateBashCompletion(config) {
+  const lines = [];
+  const name = config.name;
+  lines.push(`_${name}_completions() {`);
+  lines.push('  local cur="${COMP_WORDS[COMP_CWORD]}"');
+  lines.push('  local prev="${COMP_WORDS[COMP_CWORD-1]}"');
+  lines.push("");
+  lines.push("  case $prev ;;");
+  lines.push(`    ${name})`);
+  lines.push(
+    `      COMPREPLY=($(compgen -W "${Object.keys(config.commands).join(" ")}" -- "$cur"))`
+  );
+  lines.push("      return 0");
+  lines.push("      ;;");
+  for (const [cmdName, cmd] of Object.entries(config.commands)) {
+    if (cmd.commands) {
+      lines.push(`    ${cmdName})`);
+      lines.push(
+        `      COMPREPLY=($(compgen -W "${Object.keys(cmd.commands).join(" ")}" -- "$cur"))`
+      );
+      lines.push("      return 0");
+      lines.push("      ;;");
+    }
+  }
+  lines.push("  esac");
+  lines.push("");
+  lines.push('  COMPREPLY=($(compgen -W "--help --version" -- "$cur"))');
+  lines.push("}");
+  lines.push("");
+  lines.push(`complete -F _${name}_completions ${name}`);
+  return lines.join("\n");
+}
+function generateZshCompletion(config) {
+  const lines = [];
+  const name = config.name;
+  lines.push(`#compdef ${name}`);
+  lines.push("");
+  lines.push(`_${name}() {`);
+  lines.push("  local -a commands");
+  lines.push("  commands=(");
+  for (const [cmdName, cmd] of Object.entries(config.commands)) {
+    const desc = cmd.description ?? cmdName;
+    lines.push(`    '${cmdName}:${desc}'`);
+  }
+  lines.push("  )");
+  lines.push("");
+  lines.push("  _arguments -C \\");
+  lines.push("    '--help[Show help]' \\");
+  lines.push("    '--version[Show version]' \\");
+  lines.push("    '1:command:->commands' \\");
+  lines.push("    '*::arg:->args'");
+  lines.push("");
+  lines.push("  case $state in");
+  lines.push("    commands)");
+  lines.push("      _describe 'command' commands");
+  lines.push("      ;;");
+  lines.push("  esac");
+  lines.push("}");
+  lines.push("");
+  lines.push(`compdef _${name} ${name}`);
+  return lines.join("\n");
+}
+function generateFishCompletion(config) {
+  const lines = [];
+  const name = config.name;
+  lines.push(
+    `complete -c ${name} -f -n "__fish_use_subcommand" -a "--help" -d "Show help"`
+  );
+  lines.push(
+    `complete -c ${name} -f -n "__fish_use_subcommand" -a "--version" -d "Show version"`
+  );
+  for (const [cmdName, cmd] of Object.entries(config.commands)) {
+    const desc = cmd.description ?? cmdName;
+    lines.push(
+      `complete -c ${name} -f -n "__fish_use_subcommand" -a "${cmdName}" -d "${desc}"`
+    );
+    if (cmd.commands) {
+      for (const [subName, subCmd] of Object.entries(cmd.commands)) {
+        const subDesc = subCmd.description ?? subName;
+        lines.push(
+          `complete -c ${name} -f -n "__fish_seen_subcommand_from ${cmdName}" -a "${subName}" -d "${subDesc}"`
+        );
+      }
+    }
+  }
+  return lines.join("\n");
+}
+function generateCompletion(shell, config) {
+  switch (shell) {
+    case "bash":
+      return generateBashCompletion(config);
+    case "zsh":
+      return generateZshCompletion(config);
+    case "fish":
+      return generateFishCompletion(config);
+  }
+}
+export {
+  generateBashCompletion,
+  generateCompletion,
+  generateFishCompletion,
+  generateZshCompletion
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/generator.ts"],"sourcesContent":["interface CommandDef {\r\n  description?: string;\r\n  commands?: Record<string, CommandDef>;\r\n  flags?: Record<string, { alias?: string; description?: string }>;\r\n}\r\n\r\ninterface CLIConfig {\r\n  name: string;\r\n  commands: Record<string, CommandDef>;\r\n}\r\n\r\n/**\r\n * Generates Bash completion script.\r\n *\r\n * @param config - The CLI configuration including commands.\r\n * @returns The Bash completion script.\r\n */\r\nexport function generateBashCompletion(config: CLIConfig): string {\r\n  const lines: string[] = [];\r\n  const name = config.name;\r\n\r\n  lines.push(`_${name}_completions() {`);\r\n  lines.push('  local cur=\"${COMP_WORDS[COMP_CWORD]}\"');\r\n  lines.push('  local prev=\"${COMP_WORDS[COMP_CWORD-1]}\"');\r\n  lines.push(\"\");\r\n  lines.push(\"  case $prev ;;\");\r\n  lines.push(`    ${name})`);\r\n  lines.push(\r\n    `      COMPREPLY=($(compgen -W \"${Object.keys(config.commands).join(\" \")}\" -- \"$cur\"))`\r\n  );\r\n  lines.push(\"      return 0\");\r\n  lines.push(\"      ;;\");\r\n\r\n  for (const [cmdName, cmd] of Object.entries(config.commands)) {\r\n    if (cmd.commands) {\r\n      lines.push(`    ${cmdName})`);\r\n      lines.push(\r\n        `      COMPREPLY=($(compgen -W \"${Object.keys(cmd.commands).join(\" \")}\" -- \"$cur\"))`\r\n      );\r\n      lines.push(\"      return 0\");\r\n      lines.push(\"      ;;\");\r\n    }\r\n  }\r\n\r\n  lines.push(\"  esac\");\r\n  lines.push(\"\");\r\n  lines.push('  COMPREPLY=($(compgen -W \"--help --version\" -- \"$cur\"))');\r\n  lines.push(\"}\");\r\n  lines.push(\"\");\r\n  lines.push(`complete -F _${name}_completions ${name}`);\r\n\r\n  return lines.join(\"\\n\");\r\n}\r\n\r\n/**\r\n * Generates Zsh completion script.\r\n *\r\n * @param config - The CLI configuration including commands.\r\n * @returns The Zsh completion script.\r\n */\r\nexport function generateZshCompletion(config: CLIConfig): string {\r\n  const lines: string[] = [];\r\n  const name = config.name;\r\n\r\n  lines.push(`#compdef ${name}`);\r\n  lines.push(\"\");\r\n  lines.push(`_${name}() {`);\r\n  lines.push(\"  local -a commands\");\r\n  lines.push(\"  commands=(\");\r\n\r\n  for (const [cmdName, cmd] of Object.entries(config.commands)) {\r\n    const desc = cmd.description ?? cmdName;\r\n    lines.push(`    '${cmdName}:${desc}'`);\r\n  }\r\n\r\n  lines.push(\"  )\");\r\n  lines.push(\"\");\r\n  lines.push(\"  _arguments -C \\\\\");\r\n  lines.push(\"    '--help[Show help]' \\\\\");\r\n  lines.push(\"    '--version[Show version]' \\\\\");\r\n  lines.push(\"    '1:command:->commands' \\\\\");\r\n  lines.push(\"    '*::arg:->args'\");\r\n  lines.push(\"\");\r\n  lines.push(\"  case $state in\");\r\n  lines.push(\"    commands)\");\r\n  lines.push(\"      _describe 'command' commands\");\r\n  lines.push(\"      ;;\");\r\n  lines.push(\"  esac\");\r\n  lines.push(\"}\");\r\n  lines.push(\"\");\r\n  lines.push(`compdef _${name} ${name}`);\r\n\r\n  return lines.join(\"\\n\");\r\n}\r\n\r\n/**\r\n * Generates Fish completion script.\r\n *\r\n * @param config - The CLI configuration including commands.\r\n * @returns The Fish completion script.\r\n */\r\nexport function generateFishCompletion(config: CLIConfig): string {\r\n  const lines: string[] = [];\r\n  const name = config.name;\r\n\r\n  lines.push(\r\n    `complete -c ${name} -f -n \"__fish_use_subcommand\" -a \"--help\" -d \"Show help\"`\r\n  );\r\n  lines.push(\r\n    `complete -c ${name} -f -n \"__fish_use_subcommand\" -a \"--version\" -d \"Show version\"`\r\n  );\r\n\r\n  for (const [cmdName, cmd] of Object.entries(config.commands)) {\r\n    const desc = cmd.description ?? cmdName;\r\n    lines.push(\r\n      `complete -c ${name} -f -n \"__fish_use_subcommand\" -a \"${cmdName}\" -d \"${desc}\"`\r\n    );\r\n\r\n    if (cmd.commands) {\r\n      for (const [subName, subCmd] of Object.entries(cmd.commands)) {\r\n        const subDesc = subCmd.description ?? subName;\r\n        lines.push(\r\n          `complete -c ${name} -f -n \"__fish_seen_subcommand_from ${cmdName}\" -a \"${subName}\" -d \"${subDesc}\"`\r\n        );\r\n      }\r\n    }\r\n  }\r\n\r\n  return lines.join(\"\\n\");\r\n}\r\n\r\n/**\r\n * Supported shell types for autocomplete generation.\r\n */\r\nexport type ShellType = \"bash\" | \"zsh\" | \"fish\";\r\n\r\n/**\r\n * Generates an autocomplete script for the specified shell.\r\n *\r\n * @param shell - The target shell (\"bash\", \"zsh\", or \"fish\").\r\n * @param config - The CLI configuration including commands.\r\n * @returns The generated shell script as a string.\r\n */\r\nexport function generateCompletion(\r\n  shell: ShellType,\r\n  config: CLIConfig\r\n): string {\r\n  switch (shell) {\r\n    case \"bash\":\r\n      return generateBashCompletion(config);\r\n    case \"zsh\":\r\n      return generateZshCompletion(config);\r\n    case \"fish\":\r\n      return generateFishCompletion(config);\r\n  }\r\n}\r\n"],"mappings":";AAiBO,SAAS,uBAAuB,QAA2B;AAChE,QAAM,QAAkB,CAAC;AACzB,QAAM,OAAO,OAAO;AAEpB,QAAM,KAAK,IAAI,IAAI,kBAAkB;AACrC,QAAM,KAAK,yCAAyC;AACpD,QAAM,KAAK,4CAA4C;AACvD,QAAM,KAAK,EAAE;AACb,QAAM,KAAK,iBAAiB;AAC5B,QAAM,KAAK,OAAO,IAAI,GAAG;AACzB,QAAM;AAAA,IACJ,kCAAkC,OAAO,KAAK,OAAO,QAAQ,EAAE,KAAK,GAAG,CAAC;AAAA,EAC1E;AACA,QAAM,KAAK,gBAAgB;AAC3B,QAAM,KAAK,UAAU;AAErB,aAAW,CAAC,SAAS,GAAG,KAAK,OAAO,QAAQ,OAAO,QAAQ,GAAG;AAC5D,QAAI,IAAI,UAAU;AAChB,YAAM,KAAK,OAAO,OAAO,GAAG;AAC5B,YAAM;AAAA,QACJ,kCAAkC,OAAO,KAAK,IAAI,QAAQ,EAAE,KAAK,GAAG,CAAC;AAAA,MACvE;AACA,YAAM,KAAK,gBAAgB;AAC3B,YAAM,KAAK,UAAU;AAAA,IACvB;AAAA,EACF;AAEA,QAAM,KAAK,QAAQ;AACnB,QAAM,KAAK,EAAE;AACb,QAAM,KAAK,0DAA0D;AACrE,QAAM,KAAK,GAAG;AACd,QAAM,KAAK,EAAE;AACb,QAAM,KAAK,gBAAgB,IAAI,gBAAgB,IAAI,EAAE;AAErD,SAAO,MAAM,KAAK,IAAI;AACxB;AAQO,SAAS,sBAAsB,QAA2B;AAC/D,QAAM,QAAkB,CAAC;AACzB,QAAM,OAAO,OAAO;AAEpB,QAAM,KAAK,YAAY,IAAI,EAAE;AAC7B,QAAM,KAAK,EAAE;AACb,QAAM,KAAK,IAAI,IAAI,MAAM;AACzB,QAAM,KAAK,qBAAqB;AAChC,QAAM,KAAK,cAAc;AAEzB,aAAW,CAAC,SAAS,GAAG,KAAK,OAAO,QAAQ,OAAO,QAAQ,GAAG;AAC5D,UAAM,OAAO,IAAI,eAAe;AAChC,UAAM,KAAK,QAAQ,OAAO,IAAI,IAAI,GAAG;AAAA,EACvC;AAEA,QAAM,KAAK,KAAK;AAChB,QAAM,KAAK,EAAE;AACb,QAAM,KAAK,oBAAoB;AAC/B,QAAM,KAAK,4BAA4B;AACvC,QAAM,KAAK,kCAAkC;AAC7C,QAAM,KAAK,+BAA+B;AAC1C,QAAM,KAAK,qBAAqB;AAChC,QAAM,KAAK,EAAE;AACb,QAAM,KAAK,kBAAkB;AAC7B,QAAM,KAAK,eAAe;AAC1B,QAAM,KAAK,oCAAoC;AAC/C,QAAM,KAAK,UAAU;AACrB,QAAM,KAAK,QAAQ;AACnB,QAAM,KAAK,GAAG;AACd,QAAM,KAAK,EAAE;AACb,QAAM,KAAK,YAAY,IAAI,IAAI,IAAI,EAAE;AAErC,SAAO,MAAM,KAAK,IAAI;AACxB;AAQO,SAAS,uBAAuB,QAA2B;AAChE,QAAM,QAAkB,CAAC;AACzB,QAAM,OAAO,OAAO;AAEpB,QAAM;AAAA,IACJ,eAAe,IAAI;AAAA,EACrB;AACA,QAAM;AAAA,IACJ,eAAe,IAAI;AAAA,EACrB;AAEA,aAAW,CAAC,SAAS,GAAG,KAAK,OAAO,QAAQ,OAAO,QAAQ,GAAG;AAC5D,UAAM,OAAO,IAAI,eAAe;AAChC,UAAM;AAAA,MACJ,eAAe,IAAI,sCAAsC,OAAO,SAAS,IAAI;AAAA,IAC/E;AAEA,QAAI,IAAI,UAAU;AAChB,iBAAW,CAAC,SAAS,MAAM,KAAK,OAAO,QAAQ,IAAI,QAAQ,GAAG;AAC5D,cAAM,UAAU,OAAO,eAAe;AACtC,cAAM;AAAA,UACJ,eAAe,IAAI,uCAAuC,OAAO,SAAS,OAAO,SAAS,OAAO;AAAA,QACnG;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO,MAAM,KAAK,IAAI;AACxB;AAcO,SAAS,mBACd,OACA,QACQ;AACR,UAAQ,OAAO;AAAA,IACb,KAAK;AACH,aAAO,uBAAuB,MAAM;AAAA,IACtC,KAAK;AACH,aAAO,sBAAsB,MAAM;AAAA,IACrC,KAAK;AACH,aAAO,uBAAuB,MAAM;AAAA,EACxC;AACF;","names":[]}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "easycli-autocomplete",
+  "version": "0.0.1",
+  "description": "Shell autocomplete generator for EasyCLI",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
+    "rimraf": "^5.0.5"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "clean": "rimraf dist",
+    "typecheck": "tsc --noEmit"
+  }
+}