feat: add completion subcommand to generate shell completion scripts for Zsh, Bash, PowerShell, and Fish.
This commit is contained in:
Shakker
306
src/cli/completion-cli.ts
Normal file
306
src/cli/completion-cli.ts
Normal file
@@ -0,0 +1,306 @@
|
||||
import { Command, Option } from "commander";
|
||||
import { getSubCliEntries, registerSubCliByName } from "./program/register.subclis.js";
|
||||
|
||||
export function registerCompletionCli(program: Command) {
|
||||
program
|
||||
.command("completion")
|
||||
.description("Generate shell completion script")
|
||||
.addOption(
|
||||
new Option("-s, --shell <shell>", "Shell to generate completion for")
|
||||
.choices(["zsh", "bash", "powershell", "fish"])
|
||||
.default("zsh"),
|
||||
)
|
||||
.action(async (options) => {
|
||||
const shell = options.shell;
|
||||
// Eagerly register all subcommands to build the full tree
|
||||
const entries = getSubCliEntries();
|
||||
for (const entry of entries) {
|
||||
// Skip completion command itself to avoid cycle if we were to add it to the list
|
||||
if (entry.name === "completion") continue;
|
||||
await registerSubCliByName(program, entry.name);
|
||||
}
|
||||
|
||||
let script = "";
|
||||
if (shell === "zsh") {
|
||||
script = generateZshCompletion(program);
|
||||
} else if (shell === "bash") {
|
||||
script = generateBashCompletion(program);
|
||||
} else if (shell === "powershell") {
|
||||
script = generatePowerShellCompletion(program);
|
||||
} else if (shell === "fish") {
|
||||
script = generateFishCompletion(program);
|
||||
}
|
||||
|
||||
console.log(script);
|
||||
});
|
||||
}
|
||||
|
||||
function generateZshCompletion(program: Command): string {
|
||||
const rootCmd = program.name();
|
||||
const script = `
|
||||
#compdef ${rootCmd}
|
||||
|
||||
_${rootCmd}_completion() {
|
||||
local -a commands
|
||||
local -a options
|
||||
|
||||
_arguments -C \\
|
||||
${generateZshArgs(program)} \\
|
||||
"1: :_commands" \\
|
||||
"*::arg:->args"
|
||||
|
||||
case $state in
|
||||
(args)
|
||||
case $line[1] in
|
||||
${program.commands.map((cmd) => `(${cmd.name()}) _${rootCmd}_${cmd.name().replace(/-/g, "_")} ;;`).join("\n ")}
|
||||
esac
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
${generateZshSubcommands(program, rootCmd)}
|
||||
|
||||
compdef _${rootCmd}_completion ${rootCmd}
|
||||
`;
|
||||
return script;
|
||||
}
|
||||
|
||||
function generateZshArgs(cmd: Command): string {
|
||||
return (cmd.options || [])
|
||||
.map((opt) => {
|
||||
const flags = opt.flags.split(/[ ,|]+/);
|
||||
const name = flags.find((f) => f.startsWith("--")) || flags[0];
|
||||
const short = flags.find((f) => f.startsWith("-") && !f.startsWith("--"));
|
||||
const desc = opt.description.replace(/'/g, "'\\''");
|
||||
if (short) {
|
||||
return `"(${name} ${short})"'{${name},${short}}'[${desc}]"`;
|
||||
}
|
||||
return `"${name}[${desc}]"`;
|
||||
})
|
||||
.join(" \\\n ");
|
||||
}
|
||||
|
||||
function generateZshSubcommands(program: Command, prefix: string): string {
|
||||
let script = "";
|
||||
for (const cmd of program.commands) {
|
||||
const cmdName = cmd.name();
|
||||
const funcName = `_${prefix}_${cmdName.replace(/-/g, "_")}`;
|
||||
|
||||
// Recurse first
|
||||
script += generateZshSubcommands(cmd, `${prefix}_${cmdName.replace(/-/g, "_")}`);
|
||||
|
||||
const subCommands = cmd.commands;
|
||||
if (subCommands.length > 0) {
|
||||
script += `
|
||||
${funcName}() {
|
||||
local -a commands
|
||||
local -a options
|
||||
|
||||
_arguments -C \\
|
||||
${generateZshArgs(cmd)} \\
|
||||
"1: :_commands" \\
|
||||
"*::arg:->args"
|
||||
|
||||
case $state in
|
||||
(args)
|
||||
case $line[1] in
|
||||
${subCommands.map((sub) => `(${sub.name()}) ${funcName}_${sub.name().replace(/-/g, "_")} ;;`).join("\n ")}
|
||||
esac
|
||||
;;
|
||||
esac
|
||||
}
|
||||
`;
|
||||
} else {
|
||||
script += `
|
||||
${funcName}() {
|
||||
_arguments -C \\
|
||||
${generateZshArgs(cmd)}
|
||||
}
|
||||
`;
|
||||
}
|
||||
}
|
||||
return script;
|
||||
}
|
||||
|
||||
function generateBashCompletion(program: Command): string {
|
||||
// Simplified Bash completion using dynamic iteration logic (often hardcoded in static scripts)
|
||||
// For a robust implementation, usually one maps out the tree.
|
||||
// This assumes a simple structure.
|
||||
const rootCmd = program.name();
|
||||
|
||||
// We can use a recursive function to build the case statements
|
||||
return `
|
||||
_${rootCmd}_completion() {
|
||||
local cur prev opts
|
||||
COMPREPLY=()
|
||||
cur="\${COMP_WORDS[COMP_CWORD]}"
|
||||
prev="\${COMP_WORDS[COMP_CWORD-1]}"
|
||||
|
||||
# Simple top-level completion for now
|
||||
opts="${program.commands.map((c) => c.name()).join(" ")} ${program.options.map((o) => o.flags.split(" ")[0]).join(" ")}"
|
||||
|
||||
case "\${prev}" in
|
||||
${program.commands.map((cmd) => generateBashSubcommand(cmd)).join("\n ")}
|
||||
esac
|
||||
|
||||
if [[ \${cur} == -* ]] ; then
|
||||
COMPREPLY=( $(compgen -W "\${opts}" -- \${cur}) )
|
||||
return 0
|
||||
fi
|
||||
|
||||
COMPREPLY=( $(compgen -W "\${opts}" -- \${cur}) )
|
||||
}
|
||||
|
||||
complete -F _${rootCmd}_completion ${rootCmd}
|
||||
`;
|
||||
}
|
||||
|
||||
function generateBashSubcommand(cmd: Command): string {
|
||||
// This is a naive implementation; fully recursive bash completion is complex to generate as a single string without improved state tracking.
|
||||
// For now, let's provide top-level command recognition.
|
||||
return `${cmd.name()})
|
||||
opts="${cmd.commands.map((c) => c.name()).join(" ")} ${cmd.options.map((o) => o.flags.split(" ")[0]).join(" ")}"
|
||||
COMPREPLY=( $(compgen -W "\${opts}" -- \${cur}) )
|
||||
return 0
|
||||
;;`;
|
||||
}
|
||||
|
||||
function generatePowerShellCompletion(program: Command): string {
|
||||
const rootCmd = program.name();
|
||||
|
||||
const visit = (cmd: Command, parents: string[]): string => {
|
||||
const cmdName = cmd.name();
|
||||
const fullPath = [...parents, cmdName].join(" ");
|
||||
|
||||
let script = "";
|
||||
|
||||
// Command completion for this level
|
||||
const subCommands = cmd.commands.map((c) => c.name());
|
||||
const options = cmd.options.map((o) => o.flags.split(/[ ,|]+/)[0]); // Take first flag
|
||||
const allCompletions = [...subCommands, ...options].map((s) => `'${s}'`).join(",");
|
||||
|
||||
if (allCompletions.length > 0) {
|
||||
script += `
|
||||
if ($commandPath -eq '${fullPath}') {
|
||||
$completions = @(${allCompletions})
|
||||
$completions | Where-Object { $_ -like "$wordToComplete*" } | ForEach-Object {
|
||||
[System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterName', $_)
|
||||
}
|
||||
}
|
||||
`;
|
||||
}
|
||||
|
||||
// Recurse
|
||||
for (const sub of cmd.commands) {
|
||||
script += visit(sub, [...parents, cmdName]);
|
||||
}
|
||||
|
||||
return script;
|
||||
};
|
||||
|
||||
const rootBody = visit(program, []);
|
||||
|
||||
return `
|
||||
Register-ArgumentCompleter -Native -CommandName ${rootCmd} -ScriptBlock {
|
||||
param($wordToComplete, $commandAst, $cursorPosition)
|
||||
|
||||
$commandElements = $commandAst.CommandElements
|
||||
$commandPath = ""
|
||||
|
||||
# Reconstruct command path (simple approximation)
|
||||
# Skip the executable name
|
||||
for ($i = 1; $i -lt $commandElements.Count; $i++) {
|
||||
$element = $commandElements[$i].Extent.Text
|
||||
if ($element -like "-*") { break }
|
||||
if ($i -eq $commandElements.Count - 1 -and $wordToComplete -ne "") { break } # Don't include current word being typed
|
||||
$commandPath += "$element "
|
||||
}
|
||||
$commandPath = $commandPath.Trim()
|
||||
|
||||
# Root command
|
||||
if ($commandPath -eq "") {
|
||||
$completions = @(${program.commands.map((c) => `'${c.name()}'`).join(",")}, ${program.options.map((o) => `'${o.flags.split(" ")[0]}'`).join(",")})
|
||||
$completions | Where-Object { $_ -like "$wordToComplete*" } | ForEach-Object {
|
||||
[System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterName', $_)
|
||||
}
|
||||
}
|
||||
|
||||
${rootBody}
|
||||
}
|
||||
`;
|
||||
}
|
||||
|
||||
function generateFishCompletion(program: Command): string {
|
||||
const rootCmd = program.name();
|
||||
let script = "";
|
||||
|
||||
const visit = (cmd: Command, parents: string[]) => {
|
||||
const cmdName = cmd.name();
|
||||
const fullPath = [...parents];
|
||||
if (parents.length > 0) fullPath.push(cmdName); // Only push if not root, or consistent root handling
|
||||
|
||||
// Fish uses 'seen_subcommand_from' to determine context.
|
||||
// For root: complete -c openclaw -n "__fish_use_subcommand" -a "subcmd" -d "desc"
|
||||
|
||||
// Root logic
|
||||
if (parents.length === 0) {
|
||||
// Subcommands of root
|
||||
for (const sub of cmd.commands) {
|
||||
const desc = sub.description().replace(/'/g, "'\\''");
|
||||
script += `complete -c ${rootCmd} -n "__fish_use_subcommand" -a "${sub.name()}" -d '${desc}'\n`;
|
||||
}
|
||||
// Options of root
|
||||
for (const opt of cmd.options) {
|
||||
const flags = opt.flags.split(/[ ,|]+/);
|
||||
const long = flags.find((f) => f.startsWith("--"))?.replace(/^--/, "");
|
||||
const short = flags
|
||||
.find((f) => f.startsWith("-") && !f.startsWith("--"))
|
||||
?.replace(/^-/, "");
|
||||
const desc = opt.description.replace(/'/g, "'\\''");
|
||||
let line = `complete -c ${rootCmd} -n "__fish_use_subcommand"`;
|
||||
if (short) line += ` -s ${short}`;
|
||||
if (long) line += ` -l ${long}`;
|
||||
line += ` -d '${desc}'\n`;
|
||||
script += line;
|
||||
}
|
||||
} else {
|
||||
// Nested commands
|
||||
// Logic: if seen subcommand matches parents...
|
||||
const seenCondition = `__fish_seen_subcommand_from ${parents.join(" ")}`;
|
||||
// But fish completion logic is simpler if we just say "if we haven't seen THIS command yet but seen parent"
|
||||
// Actually, a robust fish completion often requires defining a function to check current line.
|
||||
// For simplicity, we'll assume standard fish helper __fish_seen_subcommand_from.
|
||||
|
||||
// To properly scope to 'openclaw gateway' and not 'openclaw other gateway', we need to check the sequence.
|
||||
// A simplified approach:
|
||||
const parentChain = parents.join(" ");
|
||||
|
||||
// Subcommands
|
||||
for (const sub of cmd.commands) {
|
||||
const desc = sub.description().replace(/'/g, "'\\''");
|
||||
script += `complete -c ${rootCmd} -n "__fish_seen_subcommand_from ${cmdName}" -a "${sub.name()}" -d '${desc}'\n`;
|
||||
}
|
||||
// Options
|
||||
for (const opt of cmd.options) {
|
||||
const flags = opt.flags.split(/[ ,|]+/);
|
||||
const long = flags.find((f) => f.startsWith("--"))?.replace(/^--/, "");
|
||||
const short = flags
|
||||
.find((f) => f.startsWith("-") && !f.startsWith("--"))
|
||||
?.replace(/^-/, "");
|
||||
const desc = opt.description.replace(/'/g, "'\\''");
|
||||
let line = `complete -c ${rootCmd} -n "__fish_seen_subcommand_from ${cmdName}"`;
|
||||
if (short) line += ` -s ${short}`;
|
||||
if (long) line += ` -l ${long}`;
|
||||
line += ` -d '${desc}'\n`;
|
||||
script += line;
|
||||
}
|
||||
}
|
||||
|
||||
for (const sub of cmd.commands) {
|
||||
visit(sub, [...parents, cmdName]);
|
||||
}
|
||||
};
|
||||
|
||||
visit(program, []);
|
||||
return script;
|
||||
}
|
||||
@@ -227,8 +227,20 @@ const entries: SubCliEntry[] = [
|
||||
mod.registerUpdateCli(program);
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "completion",
|
||||
description: "Generate shell completion script",
|
||||
register: async (program) => {
|
||||
const mod = await import("../completion-cli.js");
|
||||
mod.registerCompletionCli(program);
|
||||
},
|
||||
},
|
||||
];
|
||||
|
||||
export function getSubCliEntries(): SubCliEntry[] {
|
||||
return entries;
|
||||
}
|
||||
|
||||
function removeCommand(program: Command, command: Command) {
|
||||
const commands = program.commands as Command[];
|
||||
const index = commands.indexOf(command);
|
||||
|
||||
Reference in New Issue
Block a user