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

package/README.md

@@ -22,12 +22,11 @@ After completing the installation, you can run `is` to start the autocomplete se
 
 ### Usage
 
-| Action                                | Command                           | Description                                      |
-| ------------------------------------- | --------------------------------- | ------------------------------------------------ |
-| Start                                 | `is`                              | Start inshellisense session on the current shell |
-| Stop                                  | `exit`                            | Stop inshellisense session on the current shell  |
-| Check If Inside Inshellisense Session | `is -c`                           | Check if shell inside inshellisense session      |
-
+| Action                                | Command | Description                                      |
+| ------------------------------------- | ------- | ------------------------------------------------ |
+| Start                                 | `is`    | Start inshellisense session on the current shell |
+| Stop                                  | `exit`  | Stop inshellisense session on the current shell  |
+| Check If Inside Inshellisense Session | `is -c` | Check if shell inside inshellisense session      |
 
 #### Keybindings
 
@@ -51,6 +50,7 @@ inshellisense supports the following shells:
 - [powershell](https://learn.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell) (Windows Powershell)
 - [cmd](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/cmd) _(experimental)_
 - [xonsh](https://xon.sh/)
+- [nushell](https://www.nushell.sh/)
 
 ## Configuration
 

package/build/isterm/commandManager.js

@@ -2,21 +2,23 @@
 // Licensed under the MIT License.
 import convert from "color-convert";
 import os from "node:os";
-import { Shell } from "../utils/shell.js";
+import { getShellPromptRewrites, Shell } from "../utils/shell.js";
 import log from "../utils/log.js";
 import { getConfig } from "../utils/config.js";
 const maxPromptPollDistance = 10;
 export class CommandManager {
     #activeCommand;
-    #previousCommandLines;
     #terminal;
+    #previousCommandLines;
     #shell;
+    #promptRewrites;
     #supportsProperOscPlacements = os.platform() !== "win32";
     constructor(terminal, shell) {
         this.#terminal = terminal;
         this.#shell = shell;
         this.#activeCommand = {};
         this.#previousCommandLines = new Set();
+        this.#promptRewrites = getShellPromptRewrites(shell);
         if (this.#supportsProperOscPlacements) {
             this.#terminal.parser.registerCsiHandler({ final: "J" }, (params) => {
                 if (params.at(0) == 3 || params.at(0) == 2) {
@@ -27,9 +29,6 @@ export class CommandManager {
         }
     }
     handlePromptStart() {
-        if (this.#activeCommand.promptStartMarker?.line == -1) {
-            this.#previousCommandLines = new Set();
-        }
         this.#activeCommand = { promptStartMarker: this.#terminal.registerMarker(0), hasOutput: false, cursorTerminated: false };
     }
     handlePromptEnd() {
@@ -46,6 +45,15 @@ export class CommandManager {
         this.handlePromptStart();
         this.#previousCommandLines = new Set();
     }
+    _extractPrompt(lineText, patterns) {
+        for (const { regex, postfix } of patterns) {
+            const customPrompt = lineText.match(new RegExp(regex))?.groups?.prompt;
+            const adjustedPrompt = this._adjustPrompt(customPrompt, lineText, postfix);
+            if (adjustedPrompt) {
+                return adjustedPrompt;
+            }
+        }
+    }
     _getWindowsPrompt(y) {
         const line = this.#terminal.buffer.active.getLine(y);
         if (!line) {
@@ -59,13 +67,9 @@ export class CommandManager {
         const inshellisenseConfig = getConfig();
         if (this.#shell == Shell.Bash) {
             if (inshellisenseConfig?.prompt?.bash != null) {
-                for (const { regex, postfix } of inshellisenseConfig.prompt.bash) {
-                    const customPrompt = lineText.match(new RegExp(regex))?.groups?.prompt;
-                    const adjustedPrompt = this._adjustPrompt(customPrompt, lineText, postfix);
-                    if (adjustedPrompt) {
-                        return adjustedPrompt;
-                    }
-                }
+                const extractedPrompt = this._extractPrompt(lineText, inshellisenseConfig.prompt.bash);
+                if (extractedPrompt)
+                    return extractedPrompt;
             }
             const bashPrompt = lineText.match(/^(?<prompt>.*\$\s?)/)?.groups?.prompt;
             if (bashPrompt) {
@@ -75,15 +79,25 @@ export class CommandManager {
                 }
             }
         }
+        if (this.#shell == Shell.Nushell) {
+            if (inshellisenseConfig?.prompt?.nu != null) {
+                const extractedPrompt = this._extractPrompt(lineText, inshellisenseConfig.prompt.nu);
+                if (extractedPrompt)
+                    return extractedPrompt;
+            }
+            const nushellPrompt = lineText.match(/(?<prompt>.*>\s?)/)?.groups?.prompt;
+            if (nushellPrompt) {
+                const adjustedPrompt = this._adjustPrompt(nushellPrompt, lineText, ">");
+                if (adjustedPrompt) {
+                    return adjustedPrompt;
+                }
+            }
+        }
         if (this.#shell == Shell.Xonsh) {
             if (inshellisenseConfig?.prompt?.xonsh != null) {
-                for (const { regex, postfix } of inshellisenseConfig.prompt.xonsh) {
-                    const customPrompt = lineText.match(new RegExp(regex))?.groups?.prompt;
-                    const adjustedPrompt = this._adjustPrompt(customPrompt, lineText, postfix);
-                    if (adjustedPrompt) {
-                        return adjustedPrompt;
-                    }
-                }
+                const extractedPrompt = this._extractPrompt(lineText, inshellisenseConfig.prompt.xonsh);
+                if (extractedPrompt)
+                    return extractedPrompt;
             }
             let xonshPrompt = lineText.match(/(?<prompt>.*@\s?)/)?.groups?.prompt;
             if (xonshPrompt) {
@@ -102,22 +116,14 @@ export class CommandManager {
         }
         if (this.#shell == Shell.Powershell || this.#shell == Shell.Pwsh) {
             if (inshellisenseConfig?.prompt?.powershell != null) {
-                for (const { regex, postfix } of inshellisenseConfig.prompt.powershell) {
-                    const customPrompt = lineText.match(new RegExp(regex))?.groups?.prompt;
-                    const adjustedPrompt = this._adjustPrompt(customPrompt, lineText, postfix);
-                    if (adjustedPrompt) {
-                        return adjustedPrompt;
-                    }
-                }
+                const extractedPrompt = this._extractPrompt(lineText, inshellisenseConfig.prompt.powershell);
+                if (extractedPrompt)
+                    return extractedPrompt;
             }
             if (inshellisenseConfig?.prompt?.pwsh != null) {
-                for (const { regex, postfix } of inshellisenseConfig.prompt.pwsh) {
-                    const customPrompt = lineText.match(new RegExp(regex))?.groups?.prompt;
-                    const adjustedPrompt = this._adjustPrompt(customPrompt, lineText, postfix);
-                    if (adjustedPrompt) {
-                        return adjustedPrompt;
-                    }
-                }
+                const extractedPrompt = this._extractPrompt(lineText, inshellisenseConfig.prompt.pwsh);
+                if (extractedPrompt)
+                    return extractedPrompt;
             }
             const pwshPrompt = lineText.match(/(?<prompt>(\(.+\)\s)?(?:PS.+>\s?))/)?.groups?.prompt;
             if (pwshPrompt) {
@@ -195,7 +201,7 @@ export class CommandManager {
         // if we haven't fond the prompt yet, poll over the next 5 lines searching for it
         if (this.#activeCommand.promptText == null && withinPollDistance) {
             for (let i = globalCursorPosition; i < this.#activeCommand.promptEndMarker.line + maxPromptPollDistance; i++) {
-                if (this.#previousCommandLines.has(i))
+                if (this.#previousCommandLines.has(i) && !this.#promptRewrites)
                     continue;
                 const promptResult = this._getWindowsPrompt(i);
                 if (promptResult != null) {
@@ -215,6 +221,8 @@ export class CommandManager {
             let suggestions = "";
             for (;;) {
                 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
                     const cell = line?.getCell(i);
                     if (cell == null)
                         continue;

package/build/isterm/pty.js

@@ -7,7 +7,7 @@ import path from "node:path";
 import url from "node:url";
 import fs from "node:fs";
 import pty from "@homebridge/node-pty-prebuilt-multiarch";
-import { Shell, getPythonPath, userZdotdir, zdotdir } from "../utils/shell.js";
+import { Shell, userZdotdir, zdotdir } from "../utils/shell.js";
 import { IsTermOscPs, IstermOscPt, IstermPromptStart, IstermPromptEnd } from "../utils/ansi.js";
 import xterm from "@xterm/headless";
 import { CommandManager } from "./commandManager.js";
@@ -143,6 +143,26 @@ export class ISTerm {
             cursorY: this.#term.buffer.active.cursorY,
         };
     }
+    _sameAccent(baseCell, targetCell) {
+        return baseCell?.isBold() == targetCell?.isBold() && baseCell?.isItalic() == targetCell?.isItalic() && baseCell?.isUnderline() == targetCell?.isUnderline();
+    }
+    _getAnsiAccents(cell) {
+        if (cell == null)
+            return "";
+        let boldAnsi = "";
+        if (cell.isBold()) {
+            boldAnsi = "\x1b[1m";
+        }
+        let italicAnsi = "";
+        if (cell.isItalic()) {
+            italicAnsi = "\x1b[3m";
+        }
+        let underlineAnsi = "";
+        if (cell.isUnderline()) {
+            underlineAnsi = "\x1b[4m";
+        }
+        return boldAnsi + italicAnsi + underlineAnsi;
+    }
     _sameColor(baseCell, targetCell) {
         return (baseCell?.getBgColorMode() == targetCell?.getBgColorMode() &&
             baseCell?.getBgColor() == targetCell?.getBgColor() &&
@@ -190,6 +210,9 @@ export class ISTerm {
                 if (!this._sameColor(prevCell, cell)) {
                     ansiLine.push(this._getAnsiColors(cell));
                 }
+                if (!this._sameAccent(prevCell, cell)) {
+                    ansiLine.push(this._getAnsiAccents(cell));
+                }
                 ansiLine.push(chars == "" ? " " : chars);
                 prevCell = cell;
             }
@@ -214,12 +237,12 @@ export class ISTerm {
     }
 }
 export const spawn = async (options) => {
-    const { shellTarget, shellArgs } = await convertToPtyTarget(options.shell);
+    const { shellTarget, shellArgs } = await convertToPtyTarget(options.shell, options.underTest);
     return new ISTerm({ ...options, shellTarget, shellArgs });
 };
-const convertToPtyTarget = async (shell) => {
+const convertToPtyTarget = async (shell, underTest) => {
     const platform = os.platform();
-    let shellTarget = shell == Shell.Bash && platform == "win32" ? await gitBashPath() : platform == "win32" ? `${shell}.exe` : shell;
+    const shellTarget = shell == Shell.Bash && platform == "win32" ? await gitBashPath() : platform == "win32" ? `${shell}.exe` : shell;
     const shellFolderPath = path.join(path.dirname(url.fileURLToPath(import.meta.url)), "..", "..", "shell");
     let shellArgs = [];
     switch (shell) {
@@ -241,10 +264,14 @@ const convertToPtyTarget = async (shell) => {
                 path.join(os.homedir(), ".config", "xonsh", "rc.d"),
             ];
             const configs = [sharedConfig, ...userConfigs].filter((config) => fs.existsSync(config));
-            shellArgs = ["-m", "xonsh", "--rc", ...configs, path.join(shellFolderPath, "shellIntegration.xsh")];
-            shellTarget = await getPythonPath();
+            shellArgs = ["--rc", ...configs, path.join(shellFolderPath, "shellIntegration.xsh")];
             break;
         }
+        case Shell.Nushell:
+            shellArgs = ["-e", `source \`${path.join(shellFolderPath, "shellIntegration.nu")}\``];
+            if (underTest)
+                shellArgs.push("-n");
+            break;
     }
     return { shellTarget, shellArgs };
 };
@@ -252,8 +279,9 @@ const convertToPtyEnv = (shell, underTest) => {
     const env = {
         ...process.env,
         ISTERM: "1",
-        ISTERM_TESTING: underTest ? "1" : undefined,
     };
+    if (underTest)
+        env.ISTERM_TESTING = "1";
     switch (shell) {
         case Shell.Cmd: {
             if (underTest) {

package/build/runtime/template.js

@@ -4,11 +4,20 @@ 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" } }));
+    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 (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" } }));
+    return files
+        .filter((f) => f.isDirectory())
+        .map((f) => ({
+        name: f.name,
+        priority: 55,
+        context: { templateType: "folders" },
+        type: "folder",
+    }));
 };
 // TODO: implement history template
 const historyTemplate = () => {

package/build/runtime/utils.js

@@ -3,7 +3,7 @@
 import path from "node:path";
 import { spawn } from "node:child_process";
 import fsAsync from "node:fs/promises";
-import { Shell } from "../utils/shell.js";
+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 });
@@ -29,7 +29,7 @@ export const resolveCwd = async (cmdToken, cwd, shell) => {
     if (cmdToken == null)
         return { cwd, pathy: false, complete: false };
     const { token } = cmdToken;
-    const sep = shell == Shell.Bash ? "/" : path.sep;
+    const sep = getPathSeperator(shell);
     if (!token.includes(sep))
         return { cwd, pathy: false, complete: false };
     const resolvedCwd = path.isAbsolute(token) ? token : path.join(cwd, token);

package/build/ui/ui-root.js

@@ -4,7 +4,7 @@ import readline from "node:readline";
 import ansi from "ansi-escapes";
 import chalk from "chalk";
 import log from "../utils/log.js";
-import { Shell } from "../utils/shell.js";
+import { getBackspaceSequence } from "../utils/shell.js";
 import isterm from "../isterm/index.js";
 import { eraseLinesBelow } from "../utils/ansi.js";
 import { SuggestionManager, MAX_LINES } from "./suggestionManager.js";
@@ -120,8 +120,8 @@ export const render = async (shell, underTest, parentTermExit) => {
             term.noop();
         }
         else if (!inputHandled) {
-            if (press.name == "backspace" && (shell === Shell.Pwsh || shell === Shell.Powershell || shell === Shell.Cmd)) {
-                term.write("\u007F");
+            if (press.name == "backspace") {
+                term.write(getBackspaceSequence(keyPress, shell));
             }
             else {
                 term.write(press.sequence);

package/build/utils/config.js

@@ -52,6 +52,7 @@ const configSchema = {
                 pwsh: promptPatternsSchema,
                 powershell: promptPatternsSchema,
                 xonsh: promptPatternsSchema,
+                nu: promptPatternsSchema,
             },
         },
     },
@@ -95,6 +96,7 @@ export const loadConfig = async (program) => {
                 powershell: config.prompt?.powershell,
                 xonsh: config.prompt?.xonsh,
                 pwsh: config.prompt?.pwsh,
+                nu: config.prompt?.nu,
             },
         };
     }

package/build/utils/shell.js

@@ -17,6 +17,7 @@ export var Shell;
     Shell["Fish"] = "fish";
     Shell["Cmd"] = "cmd";
     Shell["Xonsh"] = "xonsh";
+    Shell["Nushell"] = "nu";
 })(Shell || (Shell = {}));
 export const supportedShells = [
     Shell.Bash,
@@ -26,6 +27,7 @@ export const supportedShells = [
     Shell.Fish,
     process.platform == "win32" ? Shell.Cmd : null,
     Shell.Xonsh,
+    Shell.Nushell,
 ].filter((shell) => shell != null);
 export const userZdotdir = process.env?.ZDOTDIR ?? os.homedir() ?? `~`;
 export const zdotdir = path.join(os.tmpdir(), `is-zsh`);
@@ -68,9 +70,6 @@ export const gitBashPath = async () => {
     }
     throw new Error("unable to find a git bash executable installed");
 };
-export const getPythonPath = async () => {
-    return await which("python", { nothrow: true });
-};
 const getGitBashPaths = async () => {
     const gitDirs = new Set();
     const gitExePath = await which("git.exe", { nothrow: true });
@@ -96,3 +95,7 @@ const getGitBashPaths = async () => {
     gitBashPaths.push(`${process.env["UserProfile"]}\\scoop\\apps\\git-with-openssh\\current\\bin\\bash.exe`);
     return gitBashPaths;
 };
+export const getBackspaceSequence = (press, shell) => shell === Shell.Pwsh || shell === Shell.Powershell || shell === Shell.Cmd || shell === Shell.Nushell ? "\u007F" : press[1].sequence;
+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;

package/package.json

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

package/shell/shellIntegration.bash

@@ -1,16 +1,6 @@
 if [ -r ~/.bashrc ]; then
     . ~/.bashrc
 fi
-if [ -r /etc/profile ]; then
-    . /etc/profile
-fi
-if [ -r ~/.bash_profile ]; then
-    . ~/.bash_profile
-elif [ -r ~/.bash_login ]; then
-    . ~/.bash_login
-elif [ -r ~/.profile ]; then
-    . ~/.profile
-fi
 
 if [ -r ~/.inshellisense/bash-preexec.sh ]; then
     . ~/.inshellisense/bash-preexec.sh
@@ -62,7 +52,7 @@ __is_precmd() {
 __is_update_prompt() {
 	if [[ "$__is_custom_PS1" == "" || "$__is_custom_PS1" != "$PS1" ]]; then
         __is_original_PS1=$PS1
-		if [ $ISTERM_TESTING == "1" ]; then
+		if [[ $ISTERM_TESTING == "1" ]]; then
 			__is_original_PS1="> "
 		fi
         __is_custom_PS1="\[$(__is_prompt_start)\]$__is_original_PS1\[$(__is_prompt_end)\]"

package/shell/shellIntegration.nu

@@ -0,0 +1,28 @@
+let __is_escape_value = {|x| $x | str replace --all "\\" "\\\\" | str replace --all ";" "\\x3b" }
+
+let __is_update_cwd = { 
+    let pwd = do $__is_escape_value $env.PWD
+    $"\e]6973;CWD;($pwd)\a" 
+}
+let __is_original_PROMPT_COMMAND = if 'PROMPT_COMMAND' in $env { $env.PROMPT_COMMAND } else { "" }
+let __is_custom_PROMPT_COMMAND = {
+    let promptCommandType = $__is_original_PROMPT_COMMAND | describe
+    mut cmd = if $promptCommandType == "closure" { do $__is_original_PROMPT_COMMAND } else { $__is_original_PROMPT_COMMAND }
+    let pwd = do $__is_update_cwd
+    if 'ISTERM_TESTING' in $env {
+        $cmd = ""
+    }
+    $"\e]6973;PS\a($cmd)($pwd)"
+}
+$env.PROMPT_COMMAND = $__is_custom_PROMPT_COMMAND
+
+let __is_original_PROMPT_INDICATOR = if 'PROMPT_INDICATOR' in $env { $env.PROMPT_INDICATOR } else { "" }
+let __is_custom_PROMPT_INDICATOR = {
+    let indicatorCommandType = $__is_original_PROMPT_INDICATOR | describe
+    mut ind = if $indicatorCommandType == "closure" { do $__is_original_PROMPT_INDICATOR } else { $__is_original_PROMPT_INDICATOR }
+    if 'ISTERM_TESTING' in $env {
+        $ind = "> "
+    }
+    $"($ind)\e]6973;PE\a"
+}
+$env.PROMPT_INDICATOR = $__is_custom_PROMPT_INDICATOR

package/shell/shellIntegration.xsh

@@ -23,7 +23,7 @@ def __is_update_cwd() -> str:
 $PROMPT_FIELDS['__is_prompt_start'] = __is_prompt_start
 $PROMPT_FIELDS['__is_prompt_end'] = __is_prompt_end
 $PROMPT_FIELDS['__is_update_cwd'] = __is_update_cwd
-if $ISTERM_TESTING:
+if 'ISTERM_TESTING' in ${...}:
     $PROMPT = "> "
 
 $PROMPT = "{__is_prompt_start}{__is_update_cwd}" + $PROMPT + "{__is_prompt_end}"