feat: add command suggestions (#359)

* feat: add support for base level suggestions

Signed-off-by: Chapman Pendery <[email protected]>

* test: command suggestions

Signed-off-by: Chapman Pendery <[email protected]>

* fix: formatting

Signed-off-by: Chapman Pendery <[email protected]>

---------

Signed-off-by: Chapman Pendery <[email protected]>

Author: cpendery

src/runtime/runtime.ts

@@ -8,11 +8,11 @@ import speclist, {
 } from "@withfig/autocomplete/build/index.js";
 import path from "node:path";
 import { parseCommand, CommandToken } from "./parser.js";
-import { getArgDrivenRecommendation, getSubcommandDrivenRecommendation } from "./suggestion.js";
-import { SuggestionBlob } from "./model.js";
+import { getArgDrivenRecommendation, getSubcommandDrivenRecommendation, SuggestionIcons } from "./suggestion.js";
+import { Suggestion, SuggestionBlob } from "./model.js";
 import { buildExecuteShellCommand, resolveCwd } from "./utils.js";
 import { Shell } from "../utils/shell.js";
-import { aliasExpand } from "./alias.js";
+import { aliasExpand, getAliasNames } from "./alias.js";
 import { getConfig } from "../utils/config.js";
 import log from "../utils/log.js";
 
@@ -87,9 +87,13 @@ export const loadLocalSpecsSet = async () => {
 export const getSuggestions = async (cmd: string, cwd: string, shell: Shell): Promise<SuggestionBlob | undefined> => {
   let activeCmd = parseCommand(cmd, shell);
   const rootToken = activeCmd.at(0);
-  if (activeCmd.length === 0 || !rootToken?.complete) {
+  if (activeCmd.length === 0) {
     return;
   }
+  if (rootToken != null && !rootToken.complete) {
+    return runCommand(rootToken);
+  }
+
   activeCmd = aliasExpand(activeCmd);
 
   const spec = await loadSpec(activeCmd);
@@ -346,3 +350,37 @@ const runSubcommand = async (
   // if the subcommand has no args specified, fallback to the subcommand and ignore this item
   return runSubcommand(tokens.slice(1), subcommand, cwd, shell, persistentOptions, acceptedTokens.concat(activeToken));
 };
+
+const runCommand = async (token: CommandToken): Promise<SuggestionBlob | undefined> => {
+  const specs = Object.keys(specSet)
+    .filter((spec) => spec.startsWith(token.token))
+    .sort();
+  const aliases = getAliasNames()
+    .filter((spec) => spec.startsWith(token.token))
+    .sort();
+  return {
+    suggestions: [
+      ...aliases.map(
+        (alias) =>
+          ({
+            name: alias,
+            type: "shortcut",
+            allNames: [alias],
+            icon: SuggestionIcons.Shortcut,
+            priority: 100,
+          }) as Suggestion,
+      ),
+      ...specs.map(
+        (spec) =>
+          ({
+            name: spec,
+            type: "subcommand",
+            allNames: [spec],
+            icon: SuggestionIcons.Subcommand,
+            priority: 40,
+          }) as Suggestion,
+      ),
+    ],
+    charactersToDrop: token.tokenLength,
+  };
+};

src/tests/runtime/runtime.test.ts

@@ -46,7 +46,7 @@ describe(`parseCommand`, () => {
   });
 });
 
-const commandSuggestionsData = [
+const subcommandSuggestionsData = [
   {
     name: "brewInstallMullvad",
     command: "brew install mullvad-brow",
@@ -64,10 +64,10 @@ const commandSuggestionsData = [
   { name: "preCommitRun", command: "pre-commit run ", maxSuggestions: 1, expectedIcons: [SuggestionIcons.Option] }, // script + post-process generator w/ console logs
 ];
 
-describe(`getCommandSuggestions`, () => {
+describe(`getSubcommandSuggestions`, () => {
   beforeAll(async () => await getCommandSuggestionsSetup());
 
-  commandSuggestionsData.forEach(({ command, name, maxSuggestions, expectedNames, expectedIcons, platforms }) => {
+  subcommandSuggestionsData.forEach(({ command, name, maxSuggestions, expectedNames, expectedIcons, platforms }) => {
     if (platforms != null && !platforms.includes(process.platform)) return;
     test(name, async () => {
       const suggestions = await getSuggestions(command, process.cwd(), Shell.Bash);
@@ -91,3 +91,22 @@ const getCommandSuggestionsSetup = async () => {
 const getCommandSuggestionsCleanup = async () => {
   fs.rmSync("demo.ts");
 };
+
+const commandSuggestionsData = [
+  { name: "gi", command: "gi", maxSuggestions: 2, expectedNames: ["gibo", "git"], expectedIcons: [SuggestionIcons.Subcommand] }, // subcommand generator
+];
+
+describe(`getCommandSuggestions`, () => {
+  commandSuggestionsData.forEach(({ command, name, maxSuggestions, expectedNames, expectedIcons }) => {
+    test(name, async () => {
+      const suggestions = await getSuggestions(command, process.cwd(), Shell.Bash);
+      if (suggestions != null && suggestions.suggestions != null) {
+        suggestions.suggestions = suggestions?.suggestions.slice(0, maxSuggestions);
+      }
+      const names = suggestions?.suggestions.map((s) => s.allNames).flat() ?? [];
+      const icons = suggestions?.suggestions.map((s) => s.icon) ?? [];
+      expect(names).toEqual(expect.arrayContaining(expectedNames ?? []));
+      expect(icons).toEqual(expect.arrayContaining(expectedIcons ?? []));
+    });
+  });
+});