@microsoft/inshellisense 0.0.1-rc.12 → 0.0.1-rc.13

package/README.md

@@ -20,6 +20,33 @@ npm install -g @microsoft/inshellisense
 
 After completing the installation, you can run `is` to start the autocomplete session for your desired shell. Additionally, inshellisense is also aliased under `inshellisense` after installation.
 
+### Shell Plugin
+
+If you'd like to automatically start inshellisense when you open your shell, run the respective command for your shell. After running the command, inshellisense will automatically open when you start any new shell session:
+
+```shell
+# bash
+is init bash >> ~/.bashrc
+
+# zsh
+is init zsh >> ~/.zshrc
+
+# fish
+is init fish >> ~/.config/fish/config.fish
+
+# pwsh
+is init pwsh >> $profile
+
+# powershell
+is init powershell >> $profile
+
+# xonsh
+is init xonsh >> ~/.xonshrc
+
+# nushell
+is init nu >> $nu.env-path
+```
+
 ### Usage
 
 | Action                                | Command | Description                                      |

package/build/commands/init.js

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { Command } from "commander";
+import { initSupportedShells as shells, getShellConfig } from "../utils/shell.js";
+const supportedShells = shells.join(", ");
+const action = (program) => async (shell) => {
+    if (!shells.map((s) => s.valueOf()).includes(shell)) {
+        program.error(`Unsupported shell: '${shell}', supported shells: ${supportedShells}`, { exitCode: 1 });
+    }
+    const config = getShellConfig(shell);
+    process.stdout.write(`\n\n# ---------------- inshellisense shell plugin ----------------\n${config}`);
+    process.exit(0);
+};
+const cmd = new Command("init");
+cmd.description(`generates shell configurations for the provided shell`);
+cmd.argument("<shell>", `shell to generate configuration for, supported shells: ${supportedShells}`);
+cmd.action(action(cmd));
+export default cmd;

package/build/commands/root.js

@@ -32,5 +32,5 @@ export const action = (program) => async (options) => {
         await setupBashPreExec();
     }
     await loadAliases(shell);
-    await render(shell, options.test ?? false, options.parentTermExit ?? false);
+    await render(shell, options.test ?? false);
 };

package/build/index.js

@@ -5,6 +5,7 @@
 import { Command, Option } from "commander";
 import complete from "./commands/complete.js";
 import uninstall from "./commands/uninstall.js";
+import init from "./commands/init.js";
 import { action, supportedShells } from "./commands/root.js";
 import { getVersion } from "./utils/version.js";
 const program = new Command();
@@ -20,10 +21,10 @@ program
     .action(action(program))
     .option("-s, --shell <shell>", `shell to use for command execution, supported shells: ${supportedShells}`)
     .option("-c, --check", `check if shell is in an inshellisense session`)
-    .option("--parent-term-exit", `when inshellisense is closed, kill the parent process`)
     .addOption(hiddenOption("-T, --test", "used to make e2e tests reproducible across machines"))
     .option("-V, --verbose", `enable verbose logging`)
     .showHelpAfterError("(add --help for additional information)");
 program.addCommand(complete);
 program.addCommand(uninstall);
+program.addCommand(init);
 program.parse();

package/build/isterm/commandManager.js

@@ -223,7 +223,7 @@ export class CommandManager {
             let wrappedCommand = "";
             let suggestions = "";
             let isWrapped = false;
-            for (;;) {
+            for (; lineY < this.#terminal.buffer.active.baseY + this.#terminal.rows;) {
                 for (let i = lineY == this.#activeCommand.promptEndMarker.line ? this.#activeCommand.promptText.length : 0; i < this.#terminal.cols; i++) {
                     if (command.endsWith("    "))
                         break; // assume that a command that ends with 4 spaces is terminated, avoids capturing right prompts

package/build/runtime/parser.js

@@ -29,9 +29,10 @@ const lex = (command) => {
             readingQuotedString = false;
             const complete = idx + 1 < command.length && spaceRegex.test(command[idx + 1]);
             tokens.push({
-                token: command.slice(readingIdx, idx + 1),
+                token: command.slice(readingIdx + 1, idx),
                 complete,
                 isOption: false,
+                isQuoted: true,
             });
         }
         else if ((readingFlag && spaceRegex.test(char)) || char === "=") {
@@ -42,7 +43,7 @@ const lex = (command) => {
                 isOption: true,
             });
         }
-        else if (readingCmd && spaceRegex.test(char)) {
+        else if (readingCmd && spaceRegex.test(char) && command.at(idx - 1) !== "\\") {
             readingCmd = false;
             tokens.push({
                 token: command.slice(readingIdx, idx),
@@ -53,11 +54,21 @@ const lex = (command) => {
     });
     const reading = readingQuotedString || readingFlag || readingCmd;
     if (reading) {
-        tokens.push({
-            token: command.slice(readingIdx),
-            complete: false,
-            isOption: readingFlag,
-        });
+        if (readingQuotedString) {
+            tokens.push({
+                token: command.slice(readingIdx + 1),
+                complete: false,
+                isOption: false,
+                isQuoted: true,
+            });
+        }
+        else {
+            tokens.push({
+                token: command.slice(readingIdx),
+                complete: false,
+                isOption: readingFlag,
+            });
+        }
     }
     return tokens;
 };

package/build/runtime/suggestion.js

@@ -3,6 +3,7 @@
 import path from "node:path";
 import { runGenerator } from "./generator.js";
 import { runTemplates } from "./template.js";
+import log from "../utils/log.js";
 var SuggestionIcons;
 (function (SuggestionIcons) {
     SuggestionIcons["File"] = "\uD83D\uDCC4";
@@ -43,6 +44,9 @@ const getIcon = (icon, suggestionType) => {
 const getLong = (suggestion) => {
     return suggestion instanceof Array ? suggestion.reduce((p, c) => (p.length > c.length ? p : c)) : suggestion;
 };
+const getPathy = (type) => {
+    return type === "file" || type === "folder";
+};
 const toSuggestion = (suggestion, name, type) => {
     if (suggestion.name == null)
         return;
@@ -53,6 +57,7 @@ const toSuggestion = (suggestion, name, type) => {
         allNames: suggestion.name instanceof Array ? suggestion.name : [suggestion.name],
         priority: suggestion.priority ?? 50,
         insertValue: suggestion.insertValue,
+        pathy: getPathy(suggestion.type),
     };
 };
 function filter(suggestions, filterStrategy, partialCmd, suggestionType) {
@@ -74,6 +79,7 @@ function filter(suggestions, filterStrategy, partialCmd, suggestionType) {
                             allNames: s.name,
                             priority: s.priority ?? 50,
                             insertValue: s.insertValue,
+                            pathy: getPathy(s.type),
                         }
                         : undefined;
                 }
@@ -85,6 +91,7 @@ function filter(suggestions, filterStrategy, partialCmd, suggestionType) {
                         allNames: [s.name],
                         priority: s.priority ?? 50,
                         insertValue: s.insertValue,
+                        pathy: getPathy(s.type),
                     }
                     : undefined;
             })
@@ -104,6 +111,7 @@ function filter(suggestions, filterStrategy, partialCmd, suggestionType) {
                             allNames: s.name,
                             insertValue: s.insertValue,
                             priority: s.priority ?? 50,
+                            pathy: getPathy(s.type),
                         }
                         : undefined;
                 }
@@ -115,6 +123,7 @@ function filter(suggestions, filterStrategy, partialCmd, suggestionType) {
                         allNames: [s.name],
                         insertValue: s.insertValue,
                         priority: s.priority ?? 50,
+                        pathy: getPathy(s.type),
                     }
                     : undefined;
             })
@@ -144,6 +153,14 @@ 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 getEscapedPath = (value) => {
+    return value?.replaceAll(" ", "\\ ");
+};
+function adjustPathSuggestions(suggestions, partialToken) {
+    if (partialToken == null || partialToken.isQuoted)
+        return suggestions;
+    return suggestions.map((s) => s.pathy ? { ...s, insertValue: getEscapedPath(s.insertValue), name: s.insertValue == null ? getEscapedPath(s.name) : s.name } : s);
+}
 const removeAcceptedSuggestions = (suggestions, acceptedTokens) => {
     const seen = new Set(acceptedTokens.map((t) => t.token));
     return suggestions.filter((s) => s.allNames.every((n) => !seen.has(n)));
@@ -163,6 +180,7 @@ const removeEmptySuggestion = (suggestions) => {
     return suggestions.filter((s) => s.name.length > 0);
 };
 export const getSubcommandDrivenRecommendation = async (subcommand, persistentOptions, partialToken, argsDepleted, argsFromSubcommand, acceptedTokens, cwd) => {
+    log.debug({ msg: "suggestion point", subcommand, persistentOptions, partialToken, argsDepleted, argsFromSubcommand, acceptedTokens, cwd });
     if (argsDepleted && argsFromSubcommand) {
         return;
     }
@@ -184,7 +202,7 @@ export const getSubcommandDrivenRecommendation = async (subcommand, persistentOp
         suggestions.push(...(await templateSuggestions(activeArg?.template, activeArg?.filterStrategy, partialCmd, cwd)));
     }
     return {
-        suggestions: removeDuplicateSuggestion(removeEmptySuggestion(removeAcceptedSuggestions(suggestions.sort((a, b) => b.priority - a.priority), acceptedTokens))),
+        suggestions: removeDuplicateSuggestion(removeEmptySuggestion(removeAcceptedSuggestions(adjustPathSuggestions(suggestions.sort((a, b) => b.priority - a.priority), partialToken), acceptedTokens))),
     };
 };
 export const getArgDrivenRecommendation = async (args, subcommand, persistentOptions, partialToken, acceptedTokens, variadicArgBound, cwd) => {
@@ -204,7 +222,7 @@ export const getArgDrivenRecommendation = async (args, subcommand, persistentOpt
         suggestions.push(...optionSuggestions(allOptions, acceptedTokens, activeArg?.filterStrategy, partialCmd));
     }
     return {
-        suggestions: removeDuplicateSuggestion(removeEmptySuggestion(removeAcceptedSuggestions(suggestions.sort((a, b) => b.priority - a.priority), acceptedTokens))),
+        suggestions: removeDuplicateSuggestion(removeEmptySuggestion(removeAcceptedSuggestions(adjustPathSuggestions(suggestions.sort((a, b) => b.priority - a.priority), partialToken), acceptedTokens))),
         argumentDescription: activeArg.description ?? activeArg.name,
     };
 };

package/build/runtime/utils.js

@@ -6,7 +6,7 @@ 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 });
+    const child = spawn(command, args, { cwd, env: { ...env, ISTERM: "1" } });
     setTimeout(() => child.kill("SIGKILL"), timeout);
     let stdout = "";
     let stderr = "";
@@ -28,7 +28,8 @@ export const buildExecuteShellCommand = (timeout) => async ({ command, env, args
 export const resolveCwd = async (cmdToken, cwd, shell) => {
     if (cmdToken == null)
         return { cwd, pathy: false, complete: false };
-    const { token } = cmdToken;
+    const { token: rawToken, isQuoted } = cmdToken;
+    const token = !isQuoted ? rawToken.replaceAll("\\ ", " ") : rawToken;
     const sep = getPathSeperator(shell);
     if (!token.includes(sep))
         return { cwd, pathy: false, complete: false };

package/build/ui/ui-root.js

@@ -12,7 +12,7 @@ export const renderConfirmation = (live) => {
     const statusMessage = live ? chalk.green("live") : chalk.red("not found");
     return `inshellisense session [${statusMessage}]\n`;
 };
-export const render = async (shell, underTest, parentTermExit) => {
+export const render = async (shell, underTest) => {
     const term = await isterm.spawn({ shell, rows: process.stdout.rows, cols: process.stdout.columns, underTest });
     const suggestionManager = new SuggestionManager(term, shell);
     let hasActiveSuggestions = false;
@@ -129,9 +129,6 @@ export const render = async (shell, underTest, parentTermExit) => {
         }
     });
     term.onExit(({ exitCode }) => {
-        if (parentTermExit && process.ppid) {
-            process.kill(process.ppid);
-        }
         process.exit(exitCode);
     });
     process.stdout.on("resize", () => {

package/build/utils/shell.js

@@ -29,6 +29,7 @@ export const supportedShells = [
     Shell.Xonsh,
     Shell.Nushell,
 ].filter((shell) => shell != null);
+export const initSupportedShells = supportedShells.filter((shell) => shell != Shell.Cmd);
 export const userZdotdir = process.env?.ZDOTDIR ?? os.homedir() ?? `~`;
 export const zdotdir = path.join(os.tmpdir(), `is-zsh`);
 const configFolder = ".inshellisense";
@@ -99,3 +100,33 @@ export const getBackspaceSequence = (press, shell) => shell === Shell.Pwsh || sh
 export const getPathSeperator = (shell) => (shell == Shell.Bash || shell == Shell.Xonsh || shell == Shell.Nushell ? "/" : path.sep);
 // nu fully re-writes the prompt every keystroke resulting in duplicate start/end sequences on the same line
 export const getShellPromptRewrites = (shell) => shell == Shell.Nushell;
+export const getShellConfig = (shell) => {
+    switch (shell) {
+        case Shell.Zsh:
+        case Shell.Bash:
+            return `if [[ -z "\${ISTERM}" && $- = *i* && $- != *c* ]]; then
+  is -s ${shell} ; exit
+fi`;
+        case Shell.Powershell:
+        case Shell.Pwsh:
+            return `$__IsCommandFlag = ([Environment]::GetCommandLineArgs() | ForEach-Object { $_.contains("-Command") }) -contains $true
+$__IsNoExitFlag = ([Environment]::GetCommandLineArgs() | ForEach-Object { $_.contains("-NoExit") }) -contains $true
+$__IsInteractive = -not $__IsCommandFlag -or ($__IsCommandFlag -and $__IsNoExitFlag)
+if ([string]::IsNullOrEmpty($env:ISTERM) -and [Environment]::UserInteractive -and $__IsInteractive) {
+  is -s ${shell}
+  Stop-Process -Id $pid
+}`;
+        case Shell.Fish:
+            return `if test -z "$ISTERM" && status --is-interactive
+  is -s fish ; kill %self
+end`;
+        case Shell.Xonsh:
+            return `if 'ISTERM' not in \${...} and $XONSH_INTERACTIVE:
+    is -s xonsh ; exit`;
+        case Shell.Nushell:
+            return `if "ISTERM" not-in $env and $nu.is-interactive {
+    is -s nu ; exit
+}`;
+    }
+    return "";
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/inshellisense",
-  "version": "0.0.1-rc.12",
+  "version": "0.0.1-rc.13",
   "description": "IDE style command line auto complete",
   "type": "module",
   "engines": {