openclaw/src/cli/completion-cli.aliases.test.ts

import { afterAll, describe, expect, it } from "vitest";
import { getCompletionScript } from "./completion-cli.js";
import {
  createAliasedCompletionProgram,
  itWithFish,
  itWithPowerShell,
  PowerShellCompletionRunner,
  runGeneratedBashCompletion,
  runGeneratedFishCompletion,
} from "./completion-cli.test-support.js";

const powerShellCompletion = new PowerShellCompletionRunner();

afterAll(async () => {
  await powerShellCompletion.close();
});

// Aliases are typeable commands, so every shell must preserve their nested command paths.
describe("completion-cli command aliases", () => {
  itWithFish.each([
    ["a canonical root command", "openclaw --profile work inf", "infer"],
    ["an aliased root command", "openclaw --profile work cap", "capability"],
    ["an inline profile and alias", "openclaw --profile=work cap", "capability"],
    ["an alias-shaped profile value", "openclaw --profile capability cap", "capability"],
    ["a repeated profile and alias", "openclaw --profile first --profile second cap", "capability"],
  ])("completes real Fish root aliases after %s", (_name, commandLine, expected) => {
    expect(runGeneratedFishCompletion(createAliasedCompletionProgram(), commandLine)).toContain(
      expected,
    );
  });

  it("completes root and nested aliases in zsh lists and dispatch", () => {
    const script = getCompletionScript("zsh", createAliasedCompletionProgram());

    expect(script).toContain("'capability[Run inference]'");
    expect(script).toContain("(infer|capability) _openclaw_infer ;;");
    expect(script).toContain("'create[Add a job]'");
    expect(script).toContain("(add|create) _openclaw_cron_add ;;");
  });

  it("completes root and nested aliases in bash command paths", () => {
    const script = getCompletionScript("bash", createAliasedCompletionProgram());

    expect(script).toContain('opts="infer capability cron --profile"');
    expect(script).toContain('"infer"|"capability")');
    expect(script).toContain('"cron")');
    expect(script).toContain('opts="add create"');
    expect(script).toContain('"cron add"|"cron create")');
    expect(script).toContain('opts="--at"');
  });

  it.skipIf(process.platform === "win32")("offers options after a nested alias in bash", () => {
    expect(
      runGeneratedBashCompletion(createAliasedCompletionProgram(), [
        "openclaw",
        "--profile",
        "work",
        "cron",
        "create",
        "--a",
      ]),
    ).toEqual(["--at"]);
  });

  it("completes aliases and their subtrees in fish", () => {
    const script = getCompletionScript("fish", createAliasedCompletionProgram());

    expect(script).toContain(
      'complete -c openclaw -n "__openclaw_command_path_matches -- --profile" -a "capability" -d \'Run inference\'',
    );
    expect(script).toContain(
      'complete -c openclaw -n "__openclaw_command_path_matches capability -- --profile" -a "embed" -d \'Embed text\'',
    );
    expect(script).toContain(
      'complete -c openclaw -n "__openclaw_command_path_matches cron -- --profile" -a "create" -d \'Add a job\'',
    );
    expect(script).toContain(
      "complete -c openclaw -n \"__openclaw_command_path_matches cron create -- --profile --at\" -l at -r -d 'Schedule time'",
    );
  });

  itWithFish.each([
    ["an aliased nested command", "openclaw cron create -"],
    ["a canonical nested command", "openclaw cron add -"],
    ["a global profile", "openclaw --profile work cron create -"],
    ["an inline global profile", "openclaw --profile=work cron create -"],
    ["repeated global profiles", "openclaw --profile first --profile second cron create -"],
    ["an inherited global profile", "openclaw cron --profile work create -"],
    ["a parent long option", "openclaw cron --timezone UTC create -"],
    ["a parent short option", "openclaw cron -z UTC create -"],
    ["an inline parent option", "openclaw cron --timezone=UTC create -"],
    ["a parent boolean option", "openclaw cron --verbose create -"],
  ])("keeps real Fish alias completions scoped after %s", (_name, commandLine) => {
    const program = createAliasedCompletionProgram();
    const cron = program.commands.find((command) => command.name() === "cron");
    if (!cron) {
      throw new Error("Cron command is unavailable");
    }
    cron.option("-z, --timezone <zone>", "Time zone").option("--verbose", "Verbose output");

    expect(runGeneratedFishCompletion(program, commandLine)).toEqual(["--at"]);
  });

  itWithFish.each([
    ["an aliased positional argument", "openclaw cron create meeting -"],
    ["a canonical positional argument", "openclaw cron add meeting -"],
    ["a profiled positional argument", "openclaw --profile work cron create meeting -"],
    ["a parent option and positional argument", "openclaw cron -z UTC create meeting -"],
  ])("keeps real Fish alias options after %s", (_name, commandLine) => {
    const program = createAliasedCompletionProgram();
    const cron = program.commands.find((command) => command.name() === "cron");
    const add = cron?.commands.find((command) => command.name() === "add");
    if (!cron || !add) {
      throw new Error("Cron add command is unavailable");
    }
    cron.option("-z, --timezone <zone>", "Time zone");
    add.argument("[label...]", "Job label");

    expect(runGeneratedFishCompletion(program, commandLine)).toEqual(["--at"]);
  });

  it("completes aliases and alias command paths in PowerShell", () => {
    const script = getCompletionScript("powershell", createAliasedCompletionProgram());

    expect(script).toContain("$completions = @('infer','capability','cron','--profile')");
    expect(script).toContain("if ($commandPath -eq 'capability') {");
    expect(script).toContain("if ($commandPath -eq 'cron create') {");
  });

  it("tracks PowerShell command paths past inherited value-taking flags", () => {
    const script = getCompletionScript("powershell", createAliasedCompletionProgram());

    expect(script).toContain("$valueOptions = @('--profile')");
    expect(script).toContain("switch ($candidatePath)");
    expect(script).toContain("'cron create'");
    expect(script).toContain("'--profile','--at'");
  });

  itWithPowerShell.each([
    ["a global option", "openclaw --profile work cron create --a"],
    ["an inline global option", "openclaw --profile=work cron create --a"],
    ["repeated global options", "openclaw --profile first --profile second cron create --a"],
    ["an inherited option after the parent", "openclaw cron --profile work create --a"],
    ["the canonical nested command", "openclaw --profile work cron add --a"],
  ])("completes real PowerShell nested aliases after %s", async (_name, commandLine) => {
    expect(
      await powerShellCompletion.complete(createAliasedCompletionProgram(), commandLine),
    ).toEqual(["--at"]);
  });
});