@microsoft/inshellisense 0.0.1-rc.19 → 0.0.1-rc.20

package/README.md

@@ -93,7 +93,7 @@ You can customize the keybindings for inshellisense by adding a `bindings` secti
 ```toml
 [bindings.acceptSuggestion]
 key = "tab"
-# shift and tab are optional and default to false
+# shift and ctrl are optional and default to false
 shift = false
 ctrl = false
 

package/build/commands/root.js

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

package/build/index.js

@@ -26,7 +26,6 @@ program
     .option("-c, --check", `check if shell is in an inshellisense session`)
     .addOption(hiddenOption("-T, --test", "used to make e2e tests reproducible across machines"))
     .option("-V, --verbose", `enable verbose logging`)
-    .showHelpAfterError("(add --help for additional information)")
     .passThroughOptions();
 program.addCommand(complete);
 program.addCommand(uninstall);

package/build/isterm/pty.js

@@ -17,6 +17,7 @@ import log from "../utils/log.js";
 import { gitBashPath } from "../utils/shell.js";
 import styles from "ansi-styles";
 import * as ansi from "../utils/ansi.js";
+import which from "which";
 const ISTermOnDataEvent = "data";
 export class ISTerm {
     pid;
@@ -282,10 +283,18 @@ export class ISTerm {
         return lines.reverse().join(ansi.cursorNextLine);
     }
 }
-export const spawn = async (options) => {
+export const spawn = async (program, options) => {
     const { shellTarget, shellArgs } = await convertToPtyTarget(options.shell, options.underTest, options.login);
+    if (!(await shellExists(shellTarget))) {
+        program.error(`shell not found on PATH: ${shellTarget}`, { exitCode: 1 });
+    }
     return new ISTerm({ ...options, shellTarget, shellArgs });
 };
+const shellExists = async (shellTarget) => {
+    const fileExists = fs.existsSync(shellTarget);
+    const fileOnPath = await which(shellTarget, { nothrow: true });
+    return fileExists || fileOnPath != null;
+};
 const convertToPtyTarget = async (shell, underTest, login) => {
     const platform = os.platform();
     const shellTarget = shell == Shell.Bash && platform == "win32" ? await gitBashPath() : platform == "win32" ? `${shell}.exe` : shell;

package/build/runtime/alias.js

@@ -10,7 +10,7 @@ const platform = os.platform();
 const executeShellCommand = await buildExecuteShellCommand(5000);
 const loadBashAliases = async () => {
     const shellTarget = platform == "win32" ? await gitBashPath() : Shell.Bash;
-    const { stdout, stderr, status } = await executeShellCommand({ command: shellTarget, args: ["-i", "-c", "alias"], cwd: process.cwd() });
+    const { stdout, stderr, status } = await executeShellCommand({ command: shellTarget, args: ["-i", "-c", "alias"], cwd: process.cwd(), env: { ISTERM: "1" } });
     if (status !== 0) {
         log.debug({ msg: "failed to load bash aliases", stderr, status });
         return;
@@ -24,7 +24,7 @@ const loadBashAliases = async () => {
     });
 };
 const loadZshAliases = async () => {
-    const { stdout, stderr, status } = await executeShellCommand({ command: Shell.Zsh, args: ["-i", "-c", "alias"], cwd: process.cwd() });
+    const { stdout, stderr, status } = await executeShellCommand({ command: Shell.Zsh, args: ["-i", "-c", "alias"], cwd: process.cwd(), env: { ISTERM: "1" } });
     if (status !== 0) {
         log.debug({ msg: "failed to load zsh aliases", stderr, status });
         return;

package/build/ui/ui-doctor.js

@@ -1,10 +1,11 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 import chalk from "chalk";
-import { checkLegacyConfigs, checkShellConfigs } from "../utils/shell.js";
+import { checkLegacyConfigs, checkShellConfigPlugin, checkShellConfigs } from "../utils/shell.js";
 export const render = async () => {
     let errors = 0;
     errors += await renderLegacyConfigIssues();
+    errors += await renderShellPluginIssues();
     errors += renderShellConfigIssues();
     process.exit(errors);
 };
@@ -39,3 +40,30 @@ const renderShellConfigIssues = () => {
     }
     return 0;
 };
+const renderShellPluginIssues = async () => {
+    const { shellsWithoutPlugin, shellsWithBadPlugin } = await checkShellConfigPlugin();
+    if (shellsWithoutPlugin.length == 0) {
+        process.stdout.write(chalk.green("✓") + " all shells have plugins\n");
+    }
+    else {
+        process.stderr.write(chalk.red("•") + " the following shells do not have the plugin installed:\n");
+        shellsWithoutPlugin.forEach((shell) => {
+            process.stderr.write(chalk.red("  - ") + shell + "\n");
+        });
+        process.stderr.write(chalk.yellow("  review the README to generate the missing shell plugins, this warning can be ignored if you prefer manual startup\n"));
+    }
+    if (shellsWithBadPlugin.length == 0) {
+        process.stdout.write(chalk.green("✓") + " all shells have correct plugins\n");
+    }
+    else {
+        process.stderr.write(chalk.red("•") + " the following shells have plugins incorrectly installed:\n");
+        shellsWithBadPlugin.forEach((shell) => {
+            process.stderr.write(chalk.red("  - ") + shell + "\n");
+        });
+        process.stderr.write(chalk.yellow("  remove and regenerate the plugins according to the README, only whitespace can be after the shell plugins\n"));
+    }
+    if (shellsWithoutPlugin.length > 0 || shellsWithBadPlugin.length > 0) {
+        return 1;
+    }
+    return 0;
+};

package/build/ui/ui-root.js

@@ -12,8 +12,8 @@ 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, login) => {
-    const term = await isterm.spawn({ shell, rows: process.stdout.rows, cols: process.stdout.columns, underTest, login });
+export const render = async (program, shell, underTest, login) => {
+    const term = await isterm.spawn(program, { shell, rows: process.stdout.rows, cols: process.stdout.columns, underTest, login });
     const suggestionManager = new SuggestionManager(term, shell);
     let hasActiveSuggestions = false;
     let previousSuggestionsRows = 0;

package/build/utils/shell.js

@@ -12,6 +12,17 @@ import util from "node:util";
 import childProcess from "node:child_process";
 import log from "./log.js";
 const exec = util.promisify(childProcess.exec);
+const safeExec = async (command, options) => {
+    const defaultOptions = { timeout: 500, env: { ISTERM: "1" } };
+    try {
+        const { stdout, stderr } = await exec(command, { ...defaultOptions, ...options });
+        return { stdout, stderr };
+    }
+    catch (e) {
+        log.debug({ msg: `error executing exec command: ${e}` });
+        return { stdout: undefined, stderr: undefined };
+    }
+};
 export var Shell;
 (function (Shell) {
     Shell["Bash"] = "bash";
@@ -64,14 +75,33 @@ export const checkLegacyConfigs = async () => {
     }
     return shellsWithLegacyConfig;
 };
+export const checkShellConfigPlugin = async () => {
+    const shellsWithoutPlugin = [];
+    const shellsWithBadPlugin = [];
+    for (const shell of supportedShells) {
+        const profilePath = await getProfilePath(shell);
+        if (profilePath != null && fs.existsSync(profilePath)) {
+            const profile = await fsAsync.readFile(profilePath, "utf8");
+            const profileContainsSource = profile.includes(getShellSourceCommand(shell));
+            const profileEndsWithSource = profile.trimEnd().endsWith(getShellSourceCommand(shell));
+            if (!profileContainsSource) {
+                shellsWithoutPlugin.push(shell);
+            }
+            else if (!profileEndsWithSource) {
+                shellsWithBadPlugin.push(shell);
+            }
+        }
+    }
+    return { shellsWithoutPlugin, shellsWithBadPlugin };
+};
 const getProfilePath = async (shell) => {
     switch (shell) {
         case Shell.Bash:
             return path.join(os.homedir(), ".bashrc");
         case Shell.Powershell:
-            return (await exec(`echo $profile`, { shell })).stdout.trim();
+            return (await safeExec(`echo $profile`, { shell })).stdout?.trim();
         case Shell.Pwsh:
-            return (await exec(`echo $profile`, { shell })).stdout.trim();
+            return (await safeExec(`echo $profile`, { shell })).stdout?.trim();
         case Shell.Zsh:
             return path.join(os.homedir(), ".zshrc");
         case Shell.Fish:
@@ -79,7 +109,7 @@ const getProfilePath = async (shell) => {
         case Shell.Xonsh:
             return path.join(os.homedir(), ".xonshrc");
         case Shell.Nushell:
-            return (await exec(`echo $nu.env-path`, { shell })).stdout.trim();
+            return (await safeExec(`echo $nu.env-path`, { shell })).stdout?.trim();
     }
 };
 export const createShellConfigs = async () => {

package/package.json

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