@microsoft/inshellisense 0.0.1-rc.1 → 0.0.1-rc.11

package/build/runtime/runtime.js

@@ -4,15 +4,19 @@ import speclist, { diffVersionedCompletions as versionedSpeclist,
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
  } from "@withfig/autocomplete/build/index.js";
+import path from "node:path";
 import { parseCommand } from "./parser.js";
 import { getArgDrivenRecommendation, getSubcommandDrivenRecommendation } from "./suggestion.js";
-import { buildExecuteShellCommand } from "./utils.js";
+import { buildExecuteShellCommand, resolveCwd } from "./utils.js";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any -- recursive type, setting as any
 const specSet = {};
 speclist.forEach((s) => {
     let activeSet = specSet;
     const specRoutes = s.split("/");
     specRoutes.forEach((route, idx) => {
+        if (typeof activeSet !== "object") {
+            return;
+        }
         if (idx === specRoutes.length - 1) {
             const prefix = versionedSpeclist.includes(s) ? "/index.js" : `.js`;
             activeSet[route] = `@withfig/autocomplete/build/${s}${prefix}`;
@@ -46,7 +50,7 @@ const lazyLoadSpec = async (key) => {
 const lazyLoadSpecLocation = async (location) => {
     return; //TODO: implement spec location loading
 };
-export const getSuggestions = async (cmd) => {
+export const getSuggestions = async (cmd, cwd, shell) => {
     const activeCmd = parseCommand(cmd);
     const rootToken = activeCmd.at(0);
     if (activeCmd.length === 0 || !rootToken?.complete) {
@@ -58,11 +62,19 @@ export const getSuggestions = async (cmd) => {
     const subcommand = getSubcommand(spec);
     if (subcommand == null)
         return;
-    const result = await runSubcommand(activeCmd.slice(1), subcommand);
+    const lastCommand = activeCmd.at(-1);
+    const { cwd: resolvedCwd, pathy, complete: pathyComplete } = await resolveCwd(lastCommand, cwd, shell);
+    if (pathy && lastCommand) {
+        lastCommand.isPath = true;
+        lastCommand.isPathComplete = pathyComplete;
+    }
+    const result = await runSubcommand(activeCmd.slice(1), subcommand, resolvedCwd);
     if (result == null)
         return;
-    const lastCommand = activeCmd.at(-1);
-    const charactersToDrop = lastCommand?.complete ? 0 : lastCommand?.token.length ?? 0;
+    let charactersToDrop = lastCommand?.complete ? 0 : lastCommand?.token.length ?? 0;
+    if (pathy) {
+        charactersToDrop = pathyComplete ? 0 : path.basename(lastCommand?.token ?? "").length;
+    }
     return { ...result, charactersToDrop };
 };
 const getPersistentOptions = (persistentOptions, options) => {
@@ -84,12 +96,12 @@ const getSubcommand = (spec) => {
 };
 const executeShellCommand = buildExecuteShellCommand(5000);
 const genSubcommand = async (command, parentCommand) => {
-    const subcommandIdx = parentCommand.subcommands?.findIndex((s) => s.name === command);
-    if (subcommandIdx == null)
+    if (!parentCommand.subcommands || parentCommand.subcommands.length === 0)
         return;
-    const subcommand = parentCommand.subcommands?.at(subcommandIdx);
-    if (subcommand == null)
+    const subcommandIdx = parentCommand.subcommands.findIndex((s) => (Array.isArray(s.name) ? s.name.includes(command) : s.name === command));
+    if (subcommandIdx === -1)
         return;
+    const subcommand = parentCommand.subcommands[subcommandIdx];
     // this pulls in the spec from the load spec and overwrites the subcommand in the parent with the loaded spec.
     // then it returns the subcommand and clears the loadSpec field so that it doesn't get called again
     switch (typeof subcommand.loadSpec) {
@@ -142,7 +154,7 @@ const getPersistentTokens = (tokens) => {
 const getArgs = (args) => {
     return args instanceof Array ? args : args != null ? [args] : [];
 };
-const runOption = async (tokens, option, subcommand, persistentOptions, acceptedTokens) => {
+const runOption = async (tokens, option, subcommand, cwd, persistentOptions, acceptedTokens) => {
     if (tokens.length === 0) {
         throw new Error("invalid state reached, option expected but no tokens found");
     }
@@ -150,37 +162,37 @@ const runOption = async (tokens, option, subcommand, persistentOptions, accepted
     const isPersistent = persistentOptions.some((o) => (typeof o.name === "string" ? o.name === activeToken.token : o.name.includes(activeToken.token)));
     if ((option.args instanceof Array && option.args.length > 0) || option.args != null) {
         const args = option.args instanceof Array ? option.args : [option.args];
-        return runArg(tokens.slice(1), args, subcommand, persistentOptions, acceptedTokens.concat(activeToken), true, false);
+        return runArg(tokens.slice(1), args, subcommand, cwd, persistentOptions, acceptedTokens.concat(activeToken), true, false);
     }
-    return runSubcommand(tokens.slice(1), subcommand, persistentOptions, acceptedTokens.concat({ ...activeToken, isPersistent }));
+    return runSubcommand(tokens.slice(1), subcommand, cwd, persistentOptions, acceptedTokens.concat({ ...activeToken, isPersistent }));
 };
-const runArg = async (tokens, args, subcommand, persistentOptions, acceptedTokens, fromOption, fromVariadic) => {
+const runArg = async (tokens, args, subcommand, cwd, persistentOptions, acceptedTokens, fromOption, fromVariadic) => {
     if (args.length === 0) {
-        return runSubcommand(tokens, subcommand, persistentOptions, acceptedTokens, true, !fromOption);
+        return runSubcommand(tokens, subcommand, cwd, persistentOptions, acceptedTokens, true, !fromOption);
     }
     else if (tokens.length === 0) {
-        return await getArgDrivenRecommendation(args, subcommand, persistentOptions, undefined, acceptedTokens, fromVariadic);
+        return await getArgDrivenRecommendation(args, subcommand, persistentOptions, undefined, acceptedTokens, fromVariadic, cwd);
     }
     else if (!tokens.at(0)?.complete) {
-        return await getArgDrivenRecommendation(args, subcommand, persistentOptions, tokens[0].token, acceptedTokens, fromVariadic);
+        return await getArgDrivenRecommendation(args, subcommand, persistentOptions, tokens[0], acceptedTokens, fromVariadic, cwd);
     }
     const activeToken = tokens[0];
     if (args.every((a) => a.isOptional)) {
         if (activeToken.isOption) {
             const option = getOption(activeToken, persistentOptions.concat(subcommand.options ?? []));
             if (option != null) {
-                return runOption(tokens, option, subcommand, persistentOptions, acceptedTokens);
+                return runOption(tokens, option, subcommand, cwd, persistentOptions, acceptedTokens);
             }
             return;
         }
         const nextSubcommand = await genSubcommand(activeToken.token, subcommand);
         if (nextSubcommand != null) {
-            return runSubcommand(tokens.slice(1), nextSubcommand, persistentOptions, getPersistentTokens(acceptedTokens.concat(activeToken)));
+            return runSubcommand(tokens.slice(1), nextSubcommand, cwd, persistentOptions, getPersistentTokens(acceptedTokens.concat(activeToken)));
         }
     }
     const activeArg = args[0];
     if (activeArg.isVariadic) {
-        return runArg(tokens.slice(1), args, subcommand, persistentOptions, acceptedTokens.concat(activeToken), fromOption, true);
+        return runArg(tokens.slice(1), args, subcommand, cwd, persistentOptions, acceptedTokens.concat(activeToken), fromOption, true);
     }
     else if (activeArg.isCommand) {
         if (tokens.length <= 0) {
@@ -192,16 +204,16 @@ const runArg = async (tokens, args, subcommand, persistentOptions, acceptedToken
         const subcommand = getSubcommand(spec);
         if (subcommand == null)
             return;
-        return runSubcommand(tokens.slice(1), subcommand);
+        return runSubcommand(tokens.slice(1), subcommand, cwd);
     }
-    return runArg(tokens.slice(1), args.slice(1), subcommand, persistentOptions, acceptedTokens.concat(activeToken), fromOption, false);
+    return runArg(tokens.slice(1), args.slice(1), subcommand, cwd, persistentOptions, acceptedTokens.concat(activeToken), fromOption, false);
 };
-const runSubcommand = async (tokens, subcommand, persistentOptions = [], acceptedTokens = [], argsDepleted = false, argsUsed = false) => {
+const runSubcommand = async (tokens, subcommand, cwd, persistentOptions = [], acceptedTokens = [], argsDepleted = false, argsUsed = false) => {
     if (tokens.length === 0) {
-        return getSubcommandDrivenRecommendation(subcommand, persistentOptions, undefined, argsDepleted, argsUsed, acceptedTokens);
+        return getSubcommandDrivenRecommendation(subcommand, persistentOptions, undefined, argsDepleted, argsUsed, acceptedTokens, cwd);
     }
     else if (!tokens.at(0)?.complete) {
-        return getSubcommandDrivenRecommendation(subcommand, persistentOptions, tokens[0].token, argsDepleted, argsUsed, acceptedTokens);
+        return getSubcommandDrivenRecommendation(subcommand, persistentOptions, tokens[0], argsDepleted, argsUsed, acceptedTokens, cwd);
     }
     const activeToken = tokens[0];
     const activeArgsLength = subcommand.args instanceof Array ? subcommand.args.length : 1;
@@ -209,16 +221,21 @@ const runSubcommand = async (tokens, subcommand, persistentOptions = [], accepte
     if (activeToken.isOption) {
         const option = getOption(activeToken, allOptions);
         if (option != null) {
-            return runOption(tokens, option, subcommand, persistentOptions, acceptedTokens);
+            return runOption(tokens, option, subcommand, cwd, persistentOptions, acceptedTokens);
         }
         return;
     }
     const nextSubcommand = await genSubcommand(activeToken.token, subcommand);
     if (nextSubcommand != null) {
-        return runSubcommand(tokens.slice(1), nextSubcommand, getPersistentOptions(persistentOptions, subcommand.options), getPersistentTokens(acceptedTokens.concat(activeToken)));
+        return runSubcommand(tokens.slice(1), nextSubcommand, cwd, getPersistentOptions(persistentOptions, subcommand.options), getPersistentTokens(acceptedTokens.concat(activeToken)));
     }
     if (activeArgsLength <= 0) {
         return; // not subcommand or option & no args exist
     }
-    return runArg(tokens, getArgs(subcommand.args), subcommand, allOptions, acceptedTokens, false, false);
+    const args = getArgs(subcommand.args);
+    if (args.length != 0) {
+        return runArg(tokens, args, subcommand, cwd, allOptions, acceptedTokens, false, false);
+    }
+    // if the subcommand has no args specified, fallback to the subcommand and ignore this item
+    return runSubcommand(tokens.slice(1), subcommand, cwd, persistentOptions, acceptedTokens.concat(activeToken));
 };

package/build/runtime/suggestion.js

@@ -1,5 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
+import path from "node:path";
 import { runGenerator } from "./generator.js";
 import { runTemplates } from "./template.js";
 var SuggestionIcons;
@@ -14,7 +15,11 @@ var SuggestionIcons;
     SuggestionIcons["Special"] = "\u2B50";
     SuggestionIcons["Default"] = "\uD83D\uDCC0";
 })(SuggestionIcons || (SuggestionIcons = {}));
-const getIcon = (suggestionType) => {
+const getIcon = (icon, suggestionType) => {
+    // TODO: enable fig icons once spacing is better
+    // if (icon && /[^\u0000-\u00ff]/.test(icon)) {
+    //   return icon;
+    // }
     switch (suggestionType) {
         case "arg":
             return SuggestionIcons.Argument;
@@ -44,7 +49,7 @@ const toSuggestion = (suggestion, name, type) => {
     return {
         name: name ?? getLong(suggestion.name),
         description: suggestion.description,
-        icon: getIcon(type ?? suggestion.type),
+        icon: getIcon(suggestion.icon, type ?? suggestion.type),
         allNames: suggestion.name instanceof Array ? suggestion.name : [suggestion.name],
         priority: suggestion.priority ?? 50,
         insertValue: suggestion.insertValue,
@@ -65,7 +70,7 @@ function filter(suggestions, filterStrategy, partialCmd, suggestionType) {
                         ? {
                             name: matchedName,
                             description: s.description,
-                            icon: getIcon(s.type ?? suggestionType),
+                            icon: getIcon(s.icon, s.type ?? suggestionType),
                             allNames: s.name,
                             priority: s.priority ?? 50,
                             insertValue: s.insertValue,
@@ -76,7 +81,7 @@ function filter(suggestions, filterStrategy, partialCmd, suggestionType) {
                     ? {
                         name: s.name,
                         description: s.description,
-                        icon: getIcon(s.type ?? suggestionType),
+                        icon: getIcon(s.icon, s.type ?? suggestionType),
                         allNames: [s.name],
                         priority: s.priority ?? 50,
                         insertValue: s.insertValue,
@@ -95,7 +100,7 @@ function filter(suggestions, filterStrategy, partialCmd, suggestionType) {
                         ? {
                             name: matchedName,
                             description: s.description,
-                            icon: getIcon(s.type ?? suggestionType),
+                            icon: getIcon(s.icon, s.type ?? suggestionType),
                             allNames: s.name,
                             insertValue: s.insertValue,
                             priority: s.priority ?? 50,
@@ -106,7 +111,7 @@ function filter(suggestions, filterStrategy, partialCmd, suggestionType) {
                     ? {
                         name: s.name,
                         description: s.description,
-                        icon: getIcon(s.type ?? suggestionType),
+                        icon: getIcon(s.icon, s.type ?? suggestionType),
                         allNames: [s.name],
                         insertValue: s.insertValue,
                         priority: s.priority ?? 50,
@@ -116,14 +121,16 @@ function filter(suggestions, filterStrategy, partialCmd, suggestionType) {
                 .filter((s) => s != null);
     }
 }
-const generatorSuggestions = async (generator, acceptedTokens, filterStrategy, partialCmd) => {
+const generatorSuggestions = async (generator, acceptedTokens, filterStrategy, partialCmd, cwd) => {
     const generators = generator instanceof Array ? generator : generator ? [generator] : [];
     const tokens = acceptedTokens.map((t) => t.token);
-    const suggestions = (await Promise.all(generators.map((gen) => runGenerator(gen, tokens)))).flat();
-    return filter(suggestions, filterStrategy, partialCmd, undefined);
+    if (partialCmd)
+        tokens.push(partialCmd);
+    const suggestions = (await Promise.all(generators.map((gen) => runGenerator(gen, tokens, cwd)))).flat();
+    return filter(suggestions.map((suggestion) => ({ ...suggestion, priority: suggestion.priority ?? 60 })), filterStrategy, partialCmd, undefined);
 };
-const templateSuggestions = async (templates, filterStrategy, partialCmd) => {
-    return filter(await runTemplates(templates ?? []), filterStrategy, partialCmd, undefined);
+const templateSuggestions = async (templates, filterStrategy, partialCmd, cwd) => {
+    return filter(await runTemplates(templates ?? [], cwd), filterStrategy, partialCmd, undefined);
 };
 const suggestionSuggestions = (suggestions, filterStrategy, partialCmd) => {
     const cleanedSuggestions = suggestions?.map((s) => (typeof s === "string" ? { name: s } : s)) ?? [];
@@ -137,17 +144,32 @@ const optionSuggestions = (options, acceptedTokens, filterStrategy, partialCmd)
     const validOptions = options?.filter((o) => o.exclusiveOn?.every((exclusiveOption) => !usedOptions.has(exclusiveOption)) ?? true);
     return filter(validOptions ?? [], filterStrategy, partialCmd, "option");
 };
-const removeDuplicateSuggestions = (suggestions, acceptedTokens) => {
+const removeAcceptedSuggestions = (suggestions, acceptedTokens) => {
     const seen = new Set(acceptedTokens.map((t) => t.token));
     return suggestions.filter((s) => s.allNames.every((n) => !seen.has(n)));
 };
+const removeDuplicateSuggestion = (suggestions) => {
+    const seen = new Set();
+    return suggestions
+        .map((s) => {
+        if (seen.has(s.name))
+            return null;
+        seen.add(s.name);
+        return s;
+    })
+        .filter((s) => s != null);
+};
 const removeEmptySuggestion = (suggestions) => {
     return suggestions.filter((s) => s.name.length > 0);
 };
-export const getSubcommandDrivenRecommendation = async (subcommand, persistentOptions, partialCmd, argsDepleted, argsFromSubcommand, acceptedTokens) => {
+export const getSubcommandDrivenRecommendation = async (subcommand, persistentOptions, partialToken, argsDepleted, argsFromSubcommand, acceptedTokens, cwd) => {
     if (argsDepleted && argsFromSubcommand) {
         return;
     }
+    let partialCmd = partialToken?.token;
+    if (partialToken?.isPath) {
+        partialCmd = partialToken.isPathComplete ? "" : path.basename(partialCmd ?? "");
+    }
     const suggestions = [];
     const argLength = subcommand.args instanceof Array ? subcommand.args.length : subcommand.args ? 1 : 0;
     const allOptions = persistentOptions.concat(subcommand.options ?? []);
@@ -157,28 +179,32 @@ export const getSubcommandDrivenRecommendation = async (subcommand, persistentOp
     }
     if (argLength != 0) {
         const activeArg = subcommand.args instanceof Array ? subcommand.args[0] : subcommand.args;
-        suggestions.push(...(await generatorSuggestions(activeArg?.generators, acceptedTokens, activeArg?.filterStrategy, partialCmd)));
+        suggestions.push(...(await generatorSuggestions(activeArg?.generators, acceptedTokens, activeArg?.filterStrategy, partialCmd, cwd)));
         suggestions.push(...suggestionSuggestions(activeArg?.suggestions, activeArg?.filterStrategy, partialCmd));
-        suggestions.push(...(await templateSuggestions(activeArg?.template, activeArg?.filterStrategy, partialCmd)));
+        suggestions.push(...(await templateSuggestions(activeArg?.template, activeArg?.filterStrategy, partialCmd, cwd)));
     }
     return {
-        suggestions: removeEmptySuggestion(removeDuplicateSuggestions(suggestions.sort((a, b) => b.priority - a.priority), acceptedTokens)),
+        suggestions: removeDuplicateSuggestion(removeEmptySuggestion(removeAcceptedSuggestions(suggestions.sort((a, b) => b.priority - a.priority), acceptedTokens))),
     };
 };
-export const getArgDrivenRecommendation = async (args, subcommand, persistentOptions, partialCmd, acceptedTokens, variadicArgBound) => {
+export const getArgDrivenRecommendation = async (args, subcommand, persistentOptions, partialToken, acceptedTokens, variadicArgBound, cwd) => {
+    let partialCmd = partialToken?.token;
+    if (partialToken?.isPath) {
+        partialCmd = partialToken.isPathComplete ? "" : path.basename(partialCmd ?? "");
+    }
     const activeArg = args[0];
     const allOptions = persistentOptions.concat(subcommand.options ?? []);
     const suggestions = [
-        ...(await generatorSuggestions(args[0].generators, acceptedTokens, activeArg?.filterStrategy, partialCmd)),
+        ...(await generatorSuggestions(args[0].generators, acceptedTokens, activeArg?.filterStrategy, partialCmd, cwd)),
         ...suggestionSuggestions(args[0].suggestions, activeArg?.filterStrategy, partialCmd),
-        ...(await templateSuggestions(args[0].template, activeArg?.filterStrategy, partialCmd)),
+        ...(await templateSuggestions(args[0].template, activeArg?.filterStrategy, partialCmd, cwd)),
     ];
-    if ((activeArg.isOptional && !activeArg.isVariadic) || (activeArg.isVariadic && activeArg.isOptional && !variadicArgBound)) {
+    if (activeArg.isOptional || (activeArg.isVariadic && variadicArgBound)) {
         suggestions.push(...subcommandSuggestions(subcommand.subcommands, activeArg?.filterStrategy, partialCmd));
         suggestions.push(...optionSuggestions(allOptions, acceptedTokens, activeArg?.filterStrategy, partialCmd));
     }
     return {
-        suggestions: removeEmptySuggestion(removeDuplicateSuggestions(suggestions.sort((a, b) => b.priority - a.priority), acceptedTokens)),
+        suggestions: removeDuplicateSuggestion(removeEmptySuggestion(removeAcceptedSuggestions(suggestions.sort((a, b) => b.priority - a.priority), acceptedTokens))),
         argumentDescription: activeArg.description ?? activeArg.name,
     };
 };

package/build/runtime/template.js

@@ -1,14 +1,23 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import fsAsync from "fs/promises";
-import process from "node:process";
-const filepathsTemplate = async () => {
-    const files = await fsAsync.readdir(process.cwd(), { withFileTypes: true });
-    return files.filter((f) => f.isFile() || f.isDirectory()).map((f) => ({ name: f.name, priority: 90 }));
+import fsAsync from "node:fs/promises";
+import log from "../utils/log.js";
+const filepathsTemplate = async (cwd) => {
+    const files = await fsAsync.readdir(cwd, { withFileTypes: true });
+    return files
+        .filter((f) => f.isFile() || f.isDirectory())
+        .map((f) => ({ name: f.name, priority: 55, context: { templateType: "filepaths" }, type: f.isDirectory() ? "folder" : "file" }));
 };
-const foldersTemplate = async () => {
-    const files = await fsAsync.readdir(process.cwd(), { withFileTypes: true });
-    return files.filter((f) => f.isDirectory()).map((f) => ({ name: f.name, priority: 90 }));
+const foldersTemplate = async (cwd) => {
+    const files = await fsAsync.readdir(cwd, { withFileTypes: true });
+    return files
+        .filter((f) => f.isDirectory())
+        .map((f) => ({
+        name: f.name,
+        priority: 55,
+        context: { templateType: "folders" },
+        type: "folder",
+    }));
 };
 // TODO: implement history template
 const historyTemplate = () => {
@@ -18,18 +27,24 @@ const historyTemplate = () => {
 const helpTemplate = () => {
     return [];
 };
-export const runTemplates = async (template) => {
+export const runTemplates = async (template, cwd) => {
     const templates = template instanceof Array ? template : [template];
     return (await Promise.all(templates.map(async (t) => {
-        switch (t) {
-            case "filepaths":
-                return await filepathsTemplate();
-            case "folders":
-                return await foldersTemplate();
-            case "history":
-                return historyTemplate();
-            case "help":
-                return helpTemplate();
+        try {
+            switch (t) {
+                case "filepaths":
+                    return await filepathsTemplate(cwd);
+                case "folders":
+                    return await foldersTemplate(cwd);
+                case "history":
+                    return historyTemplate();
+                case "help":
+                    return helpTemplate();
+            }
+        }
+        catch (e) {
+            log.debug({ msg: "template failed", e, template: t, cwd });
+            return [];
         }
     }))).flat();
 };

package/build/runtime/utils.js

@@ -1,22 +1,52 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import { exec, spawn } from "node:child_process";
-export const buildExecuteShellCommand = (timeout) => 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars -- TODO: use cwd in the future
-async (command, cwd) => {
-    return new Promise((resolve) => {
-        exec(command, { timeout }, (_, stdout, stderr) => {
-            resolve(stdout || stderr);
-        });
+import path from "node:path";
+import { spawn } from "node:child_process";
+import fsAsync from "node:fs/promises";
+import { getPathSeperator } from "../utils/shell.js";
+import log from "../utils/log.js";
+export const buildExecuteShellCommand = (timeout) => async ({ command, env, args, cwd }) => {
+    const child = spawn(command, args, { cwd, env });
+    setTimeout(() => child.kill("SIGKILL"), timeout);
+    let stdout = "";
+    let stderr = "";
+    child.stdout.on("data", (data) => (stdout += data));
+    child.stderr.on("data", (data) => (stderr += data));
+    child.on("error", (err) => {
+        log.debug({ msg: "shell command failed", e: err.message });
     });
-};
-export const executeShellCommandTTY = async (shell, command) => {
-    const child = spawn(shell, ["-c", command.trim()], { stdio: "inherit" });
     return new Promise((resolve) => {
         child.on("close", (code) => {
             resolve({
-                code,
+                status: code ?? 0,
+                stderr,
+                stdout,
             });
         });
     });
 };
+export const resolveCwd = async (cmdToken, cwd, shell) => {
+    if (cmdToken == null)
+        return { cwd, pathy: false, complete: false };
+    const { token } = cmdToken;
+    const sep = getPathSeperator(shell);
+    if (!token.includes(sep))
+        return { cwd, pathy: false, complete: false };
+    const resolvedCwd = path.isAbsolute(token) ? token : path.join(cwd, token);
+    try {
+        await fsAsync.access(resolvedCwd, fsAsync.constants.R_OK);
+        return { cwd: resolvedCwd, pathy: true, complete: token.endsWith(sep) };
+    }
+    catch {
+        // fallback to the parent folder if possible
+        const baselessCwd = resolvedCwd.substring(0, resolvedCwd.length - path.basename(resolvedCwd).length);
+        try {
+            await fsAsync.access(baselessCwd, fsAsync.constants.R_OK);
+            return { cwd: baselessCwd, pathy: true, complete: token.endsWith(sep) };
+        }
+        catch {
+            /*empty*/
+        }
+        return { cwd, pathy: false, complete: false };
+    }
+};

package/build/ui/suggestionManager.js

@@ -0,0 +1,153 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { getSuggestions } from "../runtime/runtime.js";
+import { renderBox, truncateText, truncateMultilineText } from "./utils.js";
+import ansi from "ansi-escapes";
+import chalk from "chalk";
+import log from "../utils/log.js";
+import { getConfig } from "../utils/config.js";
+const maxSuggestions = 5;
+const suggestionWidth = 40;
+const descriptionWidth = 30;
+const descriptionHeight = 5;
+const borderWidth = 2;
+const activeSuggestionBackgroundColor = "#7D56F4";
+export const MAX_LINES = borderWidth + Math.max(maxSuggestions, descriptionHeight);
+export class SuggestionManager {
+    #term;
+    #command;
+    #activeSuggestionIdx;
+    #suggestBlob;
+    #shell;
+    constructor(terminal, shell) {
+        this.#term = terminal;
+        this.#suggestBlob = { suggestions: [] };
+        this.#command = "";
+        this.#activeSuggestionIdx = 0;
+        this.#shell = shell;
+    }
+    async _loadSuggestions() {
+        const commandText = this.#term.getCommandState().commandText;
+        if (!commandText) {
+            this.#suggestBlob = undefined;
+            this.#activeSuggestionIdx = 0;
+            return;
+        }
+        if (commandText == this.#command) {
+            return;
+        }
+        this.#command = commandText;
+        const suggestionBlob = await getSuggestions(commandText, this.#term.cwd, this.#shell);
+        this.#suggestBlob = suggestionBlob;
+        this.#activeSuggestionIdx = 0;
+    }
+    _renderArgumentDescription(description, x) {
+        if (!description)
+            return "";
+        return renderBox([truncateText(description, descriptionWidth - borderWidth)], descriptionWidth, x);
+    }
+    _renderDescription(description, x) {
+        if (!description)
+            return "";
+        return renderBox(truncateMultilineText(description, descriptionWidth - borderWidth, descriptionHeight), descriptionWidth, x);
+    }
+    _descriptionRows(description) {
+        if (!description)
+            return 0;
+        return truncateMultilineText(description, descriptionWidth - borderWidth, descriptionHeight).length;
+    }
+    _renderSuggestions(suggestions, activeSuggestionIdx, x) {
+        return renderBox(suggestions.map((suggestion, idx) => {
+            const suggestionText = `${suggestion.icon} ${suggestion.name}`;
+            const truncatedSuggestion = truncateText(suggestionText, suggestionWidth - 2);
+            return idx == activeSuggestionIdx ? chalk.bgHex(activeSuggestionBackgroundColor)(truncatedSuggestion) : truncatedSuggestion;
+        }), suggestionWidth, x);
+    }
+    validate(suggestion) {
+        const commandText = this.#term.getCommandState().commandText;
+        return !commandText ? { data: "", rows: 0 } : suggestion;
+    }
+    async render(remainingLines) {
+        await this._loadSuggestions();
+        if (!this.#suggestBlob) {
+            return { data: "", rows: 0 };
+        }
+        const { suggestions, argumentDescription } = this.#suggestBlob;
+        const page = Math.min(Math.floor(this.#activeSuggestionIdx / maxSuggestions) + 1, Math.floor(suggestions.length / maxSuggestions) + 1);
+        const pagedSuggestions = suggestions.filter((_, idx) => idx < page * maxSuggestions && idx >= (page - 1) * maxSuggestions);
+        const activePagedSuggestionIndex = this.#activeSuggestionIdx % maxSuggestions;
+        const activeDescription = pagedSuggestions.at(activePagedSuggestionIndex)?.description || argumentDescription || "";
+        const wrappedPadding = this.#term.getCursorState().cursorX % this.#term.cols;
+        const maxPadding = activeDescription.length !== 0 ? this.#term.cols - suggestionWidth - descriptionWidth : this.#term.cols - suggestionWidth;
+        const swapDescription = wrappedPadding > maxPadding && activeDescription.length !== 0;
+        const swappedPadding = swapDescription ? Math.max(wrappedPadding - descriptionWidth, 0) : wrappedPadding;
+        const clampedLeftPadding = Math.min(Math.min(wrappedPadding, swappedPadding), maxPadding);
+        if (suggestions.length <= this.#activeSuggestionIdx) {
+            this.#activeSuggestionIdx = Math.max(suggestions.length - 1, 0);
+        }
+        if (pagedSuggestions.length == 0) {
+            if (argumentDescription != null) {
+                return {
+                    data: ansi.cursorHide +
+                        ansi.cursorUp(2) +
+                        ansi.cursorForward(clampedLeftPadding) +
+                        this._renderArgumentDescription(argumentDescription, clampedLeftPadding),
+                    rows: 3,
+                };
+            }
+            return { data: "", rows: 0 };
+        }
+        const suggestionRowsUsed = pagedSuggestions.length + borderWidth;
+        let descriptionRowsUsed = this._descriptionRows(activeDescription) + borderWidth;
+        let rows = Math.max(descriptionRowsUsed, suggestionRowsUsed);
+        if (rows <= remainingLines) {
+            descriptionRowsUsed = suggestionRowsUsed;
+            rows = suggestionRowsUsed;
+        }
+        const descriptionUI = ansi.cursorUp(descriptionRowsUsed - 1) +
+            (swapDescription
+                ? this._renderDescription(activeDescription, clampedLeftPadding)
+                : this._renderDescription(activeDescription, clampedLeftPadding + suggestionWidth)) +
+            ansi.cursorDown(descriptionRowsUsed - 1);
+        const suggestionUI = ansi.cursorUp(suggestionRowsUsed - 1) +
+            (swapDescription
+                ? this._renderSuggestions(pagedSuggestions, activePagedSuggestionIndex, clampedLeftPadding + descriptionWidth)
+                : this._renderSuggestions(pagedSuggestions, activePagedSuggestionIndex, clampedLeftPadding)) +
+            ansi.cursorDown(suggestionRowsUsed - 1);
+        const ui = swapDescription ? descriptionUI + suggestionUI : suggestionUI + descriptionUI;
+        return {
+            data: ansi.cursorHide + ansi.cursorForward(clampedLeftPadding) + ui + ansi.cursorShow,
+            rows,
+        };
+    }
+    update(keyPress) {
+        const { name, shift, ctrl } = keyPress;
+        if (!this.#suggestBlob) {
+            return false;
+        }
+        const { dismissSuggestions: { key: dismissKey, shift: dismissShift, control: dismissCtrl }, acceptSuggestion: { key: acceptKey, shift: acceptShift, control: acceptCtrl }, nextSuggestion: { key: nextKey, shift: nextShift, control: nextCtrl }, previousSuggestion: { key: prevKey, shift: prevShift, control: prevCtrl }, } = getConfig().bindings;
+        if (name == dismissKey && shift == !!dismissShift && ctrl == !!dismissCtrl) {
+            this.#suggestBlob = undefined;
+        }
+        else if (name == prevKey && shift == !!prevShift && ctrl == !!prevCtrl) {
+            this.#activeSuggestionIdx = Math.max(0, this.#activeSuggestionIdx - 1);
+        }
+        else if (name == nextKey && shift == !!nextShift && ctrl == !!nextCtrl) {
+            this.#activeSuggestionIdx = Math.min(this.#activeSuggestionIdx + 1, (this.#suggestBlob?.suggestions.length ?? 1) - 1);
+        }
+        else if (name == acceptKey && shift == !!acceptShift && ctrl == !!acceptCtrl) {
+            const removals = "\u007F".repeat(this.#suggestBlob?.charactersToDrop ?? 0);
+            const suggestion = this.#suggestBlob?.suggestions.at(this.#activeSuggestionIdx);
+            const chars = suggestion?.insertValue ?? suggestion?.name + " ";
+            if (this.#suggestBlob == null || !chars.trim() || this.#suggestBlob?.suggestions.length == 0) {
+                return false;
+            }
+            this.#term.write(removals + chars);
+        }
+        else {
+            return false;
+        }
+        log.debug({ msg: "handled keypress", ...keyPress });
+        return true;
+    }
+}