@microsoft/inshellisense 0.0.1-rc.15 → 0.0.1-rc.16

package/LICENSE

@@ -1,21 +1,21 @@
-    MIT License
-
-    Copyright (c) Microsoft Corporation.
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-    SOFTWARE
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -47,6 +47,8 @@ is init xonsh >> ~/.xonshrc
 is init nu >> $nu.env-path
 ```
 
+When updating your shell configuration in the future, make sure the inshellisense plugin is the last command in the file.
+
 ### Usage
 
 | Action                                | Command | Description                                      |

package/SECURITY.md

@@ -1,41 +1,41 @@
-<!-- BEGIN MICROSOFT SECURITY.MD V0.0.9 BLOCK -->
-
-## Security
-
-Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet) and [Xamarin](https://github.com/xamarin).
-
-If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/security.md/definition), please report it to us as described below.
-
-## Reporting Security Issues
-
-**Please do not report security vulnerabilities through public GitHub issues.**
-
-Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/security.md/msrc/create-report).
-
-If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/security.md/msrc/pgp).
-
-You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 
-
-Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
-
-  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
-  * Full paths of source file(s) related to the manifestation of the issue
-  * The location of the affected source code (tag/branch/commit or direct URL)
-  * Any special configuration required to reproduce the issue
-  * Step-by-step instructions to reproduce the issue
-  * Proof-of-concept or exploit code (if possible)
-  * Impact of the issue, including how an attacker might exploit the issue
-
-This information will help us triage your report more quickly.
-
-If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/security.md/msrc/bounty) page for more details about our active programs.
-
-## Preferred Languages
-
-We prefer all communications to be in English.
-
-## Policy
-
-Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/security.md/cvd).
-
-<!-- END MICROSOFT SECURITY.MD BLOCK -->
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.9 BLOCK -->
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet) and [Xamarin](https://github.com/xamarin).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/security.md/definition), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/security.md/msrc/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/security.md/msrc/pgp).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/security.md/msrc/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/security.md/cvd).
+
+<!-- END MICROSOFT SECURITY.MD BLOCK -->

package/build/commands/shellenv.js

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { Command } from "commander";
+import { shellEnvSupportedShells 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("shellenv");
+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/isterm/commandManager.js

@@ -154,12 +154,9 @@ export class CommandManager {
         const dim = (cell?.isDim() ?? 0) > 0;
         const italic = (cell?.isItalic() ?? 0) > 0;
         const dullColor = color == 8 || color == 7 || (color ?? 0) > 235 || (color == 15 && dim);
-        const dullItalic = (color ?? 0) > 235 || (dullColor && italic);
-        if (this.#shell == Shell.Powershell) {
-            return false;
-        }
-        else if (this.#shell == Shell.Pwsh) {
-            return dullItalic;
+        const dimItalic = dim || italic;
+        if (this.#shell == Shell.Pwsh || this.#shell == Shell.Powershell) {
+            return dimItalic;
         }
         return dullColor;
     }

package/build/isterm/pty.js

@@ -7,6 +7,7 @@ import path from "node:path";
 import url from "node:url";
 import fs from "node:fs";
 import stripAnsi from "strip-ansi";
+import { Unicode11Addon } from "@xterm/addon-unicode11";
 import pty from "@homebridge/node-pty-prebuilt-multiarch";
 import { Shell, userZdotdir, zdotdir } from "../utils/shell.js";
 import { IsTermOscPs, IstermOscPt, IstermPromptStart, IstermPromptEnd } from "../utils/ansi.js";
@@ -44,7 +45,10 @@ export class ISTerm {
         this.cols = this.#pty.cols;
         this.rows = this.#pty.rows;
         this.process = this.#pty.process;
+        const unicode11Addon = new Unicode11Addon();
         this.#term = new xterm.Terminal({ allowProposedApi: true, rows, cols });
+        this.#term.loadAddon(unicode11Addon);
+        this.#term.unicode.activeVersion = "11";
         this.#term.parser.registerOscHandler(IsTermOscPs, (data) => this._handleIsSequence(data));
         this.#commandManager = new CommandManager(this.#term, shell);
         this.#shell = shell;
@@ -86,7 +90,9 @@ export class ISTerm {
         return cwd;
     }
     _sanitizedPrompt(prompt) {
-        return stripAnsi(prompt);
+        // eslint-disable-next-line no-control-regex -- strip OSC control sequences
+        const oscStrippedPrompt = prompt.replace(/\x1b\][0-9]+;.*\x07/g, "");
+        return stripAnsi(oscStrippedPrompt);
     }
     _handleIsSequence(data) {
         const argsIndex = data.indexOf(";");

package/build/runtime/suggestion.js

@@ -17,10 +17,10 @@ var SuggestionIcons;
     SuggestionIcons["Default"] = "\uD83D\uDCC0";
 })(SuggestionIcons || (SuggestionIcons = {}));
 const getIcon = (icon, suggestionType) => {
-    // TODO: enable fig icons once spacing is better
-    // if (icon && /[^\u0000-\u00ff]/.test(icon)) {
-    //   return icon;
-    // }
+    // eslint-disable-next-line no-control-regex
+    if (icon && /[^\u0000-\u00ff]/.test(icon)) {
+        return icon;
+    }
     switch (suggestionType) {
         case "arg":
             return SuggestionIcons.Argument;

package/build/runtime/utils.js

@@ -6,14 +6,14 @@ 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: { ...env, ISTERM: "1" } });
+    const child = spawn(command, args, { cwd, env: { ...process.env, ...env, ISTERM: "1" } });
     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 });
+        log.debug({ msg: "shell command failed", command, args, e: err.message });
     });
     return new Promise((resolve) => {
         child.on("close", (code) => {

package/build/utils/shell.js

@@ -8,6 +8,7 @@ import fs from "node:fs";
 import url from "node:url";
 import os from "node:os";
 import fsAsync from "node:fs/promises";
+import log from "./log.js";
 export var Shell;
 (function (Shell) {
     Shell["Bash"] = "bash";
@@ -49,6 +50,14 @@ export const setupZshDotfiles = async () => {
     await fsAsync.cp(path.join(shellFolderPath, "shellIntegration-env.zsh"), path.join(zdotdir, ".zshenv"));
     await fsAsync.cp(path.join(shellFolderPath, "shellIntegration-login.zsh"), path.join(zdotdir, ".zlogin"));
 };
+const findPareentProcess = async () => {
+    try {
+        return (await find("pid", process.ppid)).at(0);
+    }
+    catch (e) {
+        log.debug({ msg: `error finding parent process: ${e}` });
+    }
+};
 export const inferShell = async () => {
     // try getting shell from shell specific env variables
     if (process.env.NU_VERSION != null) {
@@ -77,7 +86,7 @@ export const inferShell = async () => {
         /* empty */
     }
     // try getting shell from parent process
-    const processResult = (await find("pid", process.ppid)).at(0);
+    const processResult = await findPareentProcess();
     const name = processResult?.name;
     return name != null ? supportedShells.find((shell) => name.includes(shell)) : undefined;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/inshellisense",
-  "version": "0.0.1-rc.15",
+  "version": "0.0.1-rc.16",
   "description": "IDE style command line auto complete",
   "type": "module",
   "engines": {
@@ -41,6 +41,7 @@
   "dependencies": {
     "@homebridge/node-pty-prebuilt-multiarch": "^0.11.12",
     "@withfig/autocomplete": "2.651.0",
+    "@xterm/addon-unicode11": "^0.8.0",
     "@xterm/headless": "^5.5.0",
     "ajv": "^8.12.0",
     "ansi-escapes": "^6.2.0",

package/shell/shellIntegration-env.zsh

@@ -1,9 +1,12 @@
 if [[ -f $USER_ZDOTDIR/.zshenv ]]; then
+	IS_ZDOTDIR=$ZDOTDIR
 	ZDOTDIR=$USER_ZDOTDIR
 
 	# prevent recursion
-	if [[ $USER_ZDOTDIR != $ZDOTDIR ]]; then
-		ZDOTDIR=$USER_ZDOTDIR
+	if [[ $USER_ZDOTDIR != $IS_ZDOTDIR ]]; then
 		. $USER_ZDOTDIR/.zshenv
 	fi
+
+	USER_ZDOTDIR=$ZDOTDIR
+	ZDOTDIR=$IS_ZDOTDIR
 fi

package/shell/shellIntegration-rc.zsh

@@ -1,3 +1,5 @@
+autoload -U add-zsh-hook
+
 if [[ -f $USER_ZDOTDIR/.zshrc ]]; then
 	ZDOTDIR=$USER_ZDOTDIR
 	. $USER_ZDOTDIR/.zshrc
@@ -25,6 +27,12 @@ __is_escape_value() {
 			token="\\\\"
 		elif [ "$byte" = ";" ]; then
 			token="\\x3b"
+		elif [ "$byte" = $'\n' ]; then
+			token="\x0a"
+		elif [ "$byte" = $'\e' ]; then
+			token="\\x1b"
+		elif [ "$byte" = $'\a' ]; then
+			token="\\x07"
 		else
 			token="$byte"
 		fi

package/shell/shellIntegration.bash

@@ -44,6 +44,8 @@ __is_escape_value() {
 			token="\x0a"
 		elif [ "$byte" = $'\e' ]; then
 			token="\\x1b"
+		elif [ "$byte" = $'\a' ]; then
+			token="\\x07"
 		else
 			token="$byte"
 		fi

package/shell/shellIntegration.fish

@@ -9,6 +9,7 @@ function __is_escape_value
 	| string replace -a '\\' '\\\\' \
 	| string replace -a ';' '\\x3b' \
 	| string replace -a \e '\\x1b' \
+	| string replace -a \a '\\x07' \
 	| string split \n | string join '\x0a' \
 	;
 end

package/shell/shellIntegration.nu

@@ -1,4 +1,4 @@
-let __is_escape_value = {|x| $x | str replace --all "\\" "\\\\" | str replace --all ";" "\\x3b" | str replace --all "\n" '\x0a' | str replace --all "\e" "\\x1b" }
+let __is_escape_value = {|x| $x | str replace --all "\\" "\\\\" | str replace --all ";" "\\x3b" | str replace --all "\n" '\x0a' | str replace --all "\e" "\\x1b" | str replace --all "\a" "\\x07" }
 let __is_original_PROMPT_COMMAND = if 'PROMPT_COMMAND' in $env { $env.PROMPT_COMMAND } else { "" }
 let __is_original_PROMPT_INDICATOR = if 'PROMPT_INDICATOR' in $env { $env.PROMPT_INDICATOR } else { "" }
 

package/shell/shellIntegration.ps1

@@ -8,7 +8,7 @@ if ($env:ISTERM_TESTING -eq "1") {
 }
 
 function Global:__IS-Escape-Value([string]$value) {
-    [regex]::Replace($value, "[$([char]0x1b)\\\n;]", { param($match)
+    [regex]::Replace($value, "[$([char]0x1b)$([char]0x07)\\\n;]", { param($match)
             -Join (
                 [System.Text.Encoding]::UTF8.GetBytes($match.Value) | ForEach-Object { '\x{0:x2}' -f $_ }
             )

package/shell/shellIntegration.xsh

@@ -12,7 +12,7 @@ def __is_escape_value(value: str) -> str:
     byte_list = [bytes([byte]).decode("utf-8") for byte in list(value.encode("utf-8"))]
     return "".join(
         [
-            "\\x3b" if byte == ";" else "\\\\" if byte == "\\" else "\\x1b" if byte == "\x1b" else "\x0a" if byte == "\n" else byte
+            "\\x3b" if byte == ";" else "\\\\" if byte == "\\" else "\\x1b" if byte == "\x1b" else "\x0a" if byte == "\n"else "\\x07" if byte == "\x07" else byte
             for byte in byte_list
         ]
     )

package/todo.md

@@ -0,0 +1,4 @@
+- [x] improve wrapping handling
+`const wrapped = line?.isWrapped || (this.#terminal.buffer.active.cursorY + this.#terminal.buffer.active.baseY) != lineY`
+`lineY < this.#terminal.rows`
+- [ ] handle paths with spaces in them on bash (ignore pwsh for now as it fails cd anyway)