@microsoft/inshellisense 0.0.1-rc.21 → 0.0.1-rc.23

package/build/utils/config.js

@@ -1,99 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-import os from "node:os";
-import path from "node:path";
-import fs from "node:fs";
-import fsAsync from "node:fs/promises";
-import toml from "toml";
-import _Ajv from "ajv";
-const Ajv = _Ajv;
-const ajv = new Ajv();
-const bindingSchema = {
-    type: "object",
-    nullable: true,
-    properties: {
-        shift: { type: "boolean", nullable: true },
-        control: { type: "boolean", nullable: true },
-        key: { type: "string" },
-    },
-    required: ["key"],
-};
-const specPathsSchema = {
-    type: "array",
-    items: { type: "string" },
-    nullable: true,
-};
-const configSchema = {
-    type: "object",
-    nullable: true,
-    properties: {
-        bindings: {
-            type: "object",
-            nullable: true,
-            properties: {
-                nextSuggestion: bindingSchema,
-                previousSuggestion: bindingSchema,
-                dismissSuggestions: bindingSchema,
-                acceptSuggestion: bindingSchema,
-            },
-        },
-        specs: {
-            type: "object",
-            nullable: true,
-            properties: {
-                path: specPathsSchema,
-            },
-        },
-    },
-    additionalProperties: false,
-};
-const rcFile = ".inshellisenserc";
-const xdgFile = "rc.toml";
-const cachePath = path.join(os.homedir(), ".inshellisense");
-const rcPath = path.join(os.homedir(), rcFile);
-const xdgPath = path.join(os.homedir(), ".config", "inshellisense", xdgFile);
-const configPaths = [rcPath, xdgPath];
-let globalConfig = {
-    bindings: {
-        nextSuggestion: { key: "down" },
-        previousSuggestion: { key: "up" },
-        acceptSuggestion: { key: "tab" },
-        dismissSuggestions: { key: "escape" },
-    },
-};
-export const getConfig = () => globalConfig;
-export const loadConfig = async (program) => {
-    configPaths.forEach(async (configPath) => {
-        if (fs.existsSync(configPath)) {
-            let config;
-            try {
-                config = toml.parse((await fsAsync.readFile(configPath)).toString());
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            }
-            catch (e) {
-                program.error(`${configPath} is invalid toml. Parsing error on line ${e.line}, column ${e.column}: ${e.message}`);
-            }
-            const isValid = ajv.validate(configSchema, config);
-            if (!isValid) {
-                program.error(`${configPath} is invalid: ${ajv.errorsText()}`);
-            }
-            globalConfig = {
-                bindings: {
-                    nextSuggestion: config?.bindings?.nextSuggestion ?? globalConfig.bindings.nextSuggestion,
-                    previousSuggestion: config?.bindings?.previousSuggestion ?? globalConfig.bindings.previousSuggestion,
-                    acceptSuggestion: config?.bindings?.acceptSuggestion ?? globalConfig.bindings.acceptSuggestion,
-                    dismissSuggestions: config?.bindings?.dismissSuggestions ?? globalConfig.bindings.dismissSuggestions,
-                },
-                specs: {
-                    path: [...(config?.specs?.path ?? []), ...(config?.specs?.path ?? [])],
-                },
-            };
-        }
-    });
-    globalConfig.specs = { path: [`${os.homedir()}/.fig/autocomplete/build`, ...(globalConfig.specs?.path ?? [])] };
-};
-export const deleteCacheFolder = () => {
-    if (fs.existsSync(cachePath)) {
-        fs.rmSync(cachePath, { recursive: true });
-    }
-};

package/build/utils/log.js

@@ -1,39 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import os from "node:os";
-import path from "node:path";
-import fs from "node:fs";
-import fsAsync from "node:fs/promises";
-const logFolder = path.join(os.homedir(), ".inshellisense");
-const logTarget = path.join(logFolder, "inshellisense.log");
-let logEnabled = false;
-const reset = async () => {
-    if (!fs.existsSync(logTarget)) {
-        await fsAsync.mkdir(logFolder, { recursive: true });
-    }
-    await fsAsync.writeFile(logTarget, "");
-};
-const debug = (content) => {
-    if (!logEnabled) {
-        return;
-    }
-    fs.appendFile(logTarget, JSON.stringify(content) + "\n", (err) => {
-        if (err != null) {
-            throw err;
-        }
-    });
-};
-const getLogFunction = (level) => (...data) => debug({ msg: `console.${level}`, data: data.toString() });
-const logConsole = {
-    ...console,
-    log: getLogFunction("log"),
-    error: getLogFunction("error"),
-};
-// eslint-disable-next-line no-global-assign
-const overrideConsole = () => (console = logConsole);
-export const enable = async () => {
-    await reset();
-    logEnabled = true;
-};
-export default { reset, debug, enable, overrideConsole };

package/build/utils/shell.js

@@ -1,318 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-import process from "node:process";
-import find from "find-process";
-import path from "node:path";
-import which from "which";
-import fs from "node:fs";
-import url from "node:url";
-import os from "node:os";
-import fsAsync from "node:fs/promises";
-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";
-    Shell["Powershell"] = "powershell";
-    Shell["Pwsh"] = "pwsh";
-    Shell["Zsh"] = "zsh";
-    Shell["Fish"] = "fish";
-    Shell["Cmd"] = "cmd";
-    Shell["Xonsh"] = "xonsh";
-    Shell["Nushell"] = "nu";
-})(Shell || (Shell = {}));
-export const supportedShells = [
-    Shell.Bash,
-    process.platform == "win32" ? Shell.Powershell : null,
-    Shell.Pwsh,
-    Shell.Zsh,
-    Shell.Fish,
-    process.platform == "win32" ? Shell.Cmd : null,
-    Shell.Xonsh,
-    Shell.Nushell,
-].filter((shell) => shell != null);
-export const initSupportedShells = supportedShells.filter((shell) => shell != Shell.Cmd);
-export const aliasSupportedShells = [Shell.Bash, Shell.Zsh];
-export const userZdotdir = process.env?.ZDOTDIR ?? os.homedir() ?? `~`;
-export const zdotdir = path.join(os.tmpdir(), `is-zsh`);
-const configFolder = ".inshellisense";
-export const checkShellConfigs = () => {
-    const shellsWithoutConfigs = [];
-    const configFolderPath = path.join(os.homedir(), configFolder);
-    for (const shell of supportedShells) {
-        const shellConfigName = getShellConfigName(shell);
-        if (shellConfigName == null)
-            continue;
-        if (!fs.existsSync(path.join(configFolderPath, shell, shellConfigName))) {
-            shellsWithoutConfigs.push(shell);
-        }
-    }
-    return shellsWithoutConfigs;
-};
-export const checkLegacyConfigs = async () => {
-    const shellsWithLegacyConfig = [];
-    for (const shell of supportedShells) {
-        const profilePath = await getProfilePath(shell);
-        if (profilePath != null && fs.existsSync(profilePath)) {
-            const profile = await fsAsync.readFile(profilePath, "utf8");
-            if (profile.includes("inshellisense shell plugin")) {
-                shellsWithLegacyConfig.push(shell);
-            }
-        }
-    }
-    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 shellSourceCommand = getShellSourceCommand(shell).trim();
-            const profileContainsSource = profile.includes(shellSourceCommand);
-            const profileEndsWithSource = profile.trimEnd().endsWith(shellSourceCommand);
-            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 safeExec(`echo $profile`, { shell })).stdout?.trim();
-        case Shell.Pwsh:
-            return (await safeExec(`echo $profile`, { shell })).stdout?.trim();
-        case Shell.Zsh:
-            return path.join(os.homedir(), ".zshrc");
-        case Shell.Fish:
-            return path.join(os.homedir(), ".config", "fish", "config.fish");
-        case Shell.Xonsh:
-            return path.join(os.homedir(), ".xonshrc");
-        case Shell.Nushell:
-            return (await safeExec(`echo $nu.env-path`, { shell })).stdout?.trim();
-    }
-};
-export const createShellConfigs = async () => {
-    const configFolderPath = path.join(os.homedir(), configFolder);
-    for (const shell of supportedShells) {
-        const shellConfigName = getShellConfigName(shell);
-        if (shellConfigName == null)
-            continue;
-        await fsAsync.mkdir(path.join(configFolderPath, shell), { recursive: true });
-        await fsAsync.writeFile(path.join(configFolderPath, shell, shellConfigName), getShellConfig(shell));
-    }
-};
-const getShellConfigName = (shell) => {
-    switch (shell) {
-        case Shell.Bash:
-            return "init.sh";
-        case Shell.Powershell:
-        case Shell.Pwsh:
-            return "init.ps1";
-        case Shell.Zsh:
-            return "init.zsh";
-        case Shell.Fish:
-            return "init.fish";
-        case Shell.Xonsh:
-            return "init.xsh";
-        case Shell.Nushell:
-            return "init.nu";
-        default:
-            return undefined;
-    }
-};
-export const setupBashPreExec = async () => {
-    const shellFolderPath = path.join(path.dirname(url.fileURLToPath(import.meta.url)), "..", "..", "shell");
-    const globalConfigPath = path.join(os.homedir(), configFolder);
-    if (!fs.existsSync(globalConfigPath)) {
-        await fsAsync.mkdir(globalConfigPath, { recursive: true });
-    }
-    await fsAsync.cp(path.join(shellFolderPath, "bash-preexec.sh"), path.join(globalConfigPath, "bash-preexec.sh"));
-};
-export const setupZshDotfiles = async () => {
-    const shellFolderPath = path.join(path.dirname(url.fileURLToPath(import.meta.url)), "..", "..", "shell");
-    await fsAsync.cp(path.join(shellFolderPath, "shellIntegration-rc.zsh"), path.join(zdotdir, ".zshrc"));
-    await fsAsync.cp(path.join(shellFolderPath, "shellIntegration-profile.zsh"), path.join(zdotdir, ".zprofile"));
-    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 findParentProcess = 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) {
-        return Shell.Nushell;
-    }
-    else if (process.env.XONSHRC != null) {
-        return Shell.Xonsh;
-    }
-    else if (process.env.FISH_VERSION != null) {
-        return Shell.Fish;
-    }
-    else if (process.env.ZSH_VERSION != null) {
-        return Shell.Zsh;
-    }
-    else if (process.env.BASH_VERSION != null) {
-        return Shell.Bash;
-    }
-    // try getting shell from env
-    try {
-        const name = path.parse(process.env.SHELL ?? "").name;
-        const shellName = supportedShells.find((shell) => name.includes(shell));
-        if (shellName)
-            return shellName;
-    }
-    catch {
-        /* empty */
-    }
-    // try getting shell from parent process
-    const processResult = await findParentProcess();
-    const name = processResult?.name;
-    return name != null ? supportedShells.find((shell) => name.includes(shell)) : undefined;
-};
-export const gitBashPath = async () => {
-    const gitBashPaths = await getGitBashPaths();
-    for (const gitBashPath of gitBashPaths) {
-        if (fs.existsSync(gitBashPath)) {
-            return gitBashPath;
-        }
-    }
-    throw new Error("unable to find a git bash executable installed");
-};
-const getGitBashPaths = async () => {
-    const gitDirs = new Set();
-    const gitExePath = await which("git.exe", { nothrow: true });
-    if (gitExePath) {
-        const gitExeDir = path.dirname(gitExePath);
-        gitDirs.add(path.resolve(gitExeDir, "../.."));
-    }
-    const addValid = (set, value) => {
-        if (value)
-            set.add(value);
-    };
-    // Add common git install locations
-    addValid(gitDirs, process.env["ProgramW6432"]);
-    addValid(gitDirs, process.env["ProgramFiles"]);
-    addValid(gitDirs, process.env["ProgramFiles(X86)"]);
-    addValid(gitDirs, `${process.env["LocalAppData"]}\\Program`);
-    const gitBashPaths = [];
-    for (const gitDir of gitDirs) {
-        gitBashPaths.push(`${gitDir}\\Git\\bin\\bash.exe`, `${gitDir}\\Git\\usr\\bin\\bash.exe`, `${gitDir}\\usr\\bin\\bash.exe`);
-    }
-    // Add special installs that don't follow the standard directory structure
-    gitBashPaths.push(`${process.env["UserProfile"]}\\scoop\\apps\\git\\current\\bin\\bash.exe`);
-    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 getPathSeparator = (shell) => (shell == Shell.Bash || shell == Shell.Xonsh || shell == Shell.Nushell ? "/" : path.sep);
-export const removePathSeparator = (dir) => {
-    return dir.endsWith("/") || dir.endsWith("\\") ? dir.slice(0, -1) : dir;
-};
-export const addPathSeparator = (dir, shell) => {
-    const pathSep = getPathSeparator(shell);
-    return dir.endsWith(pathSep) ? dir : dir + pathSep;
-};
-export const getPathDirname = (dir, shell) => {
-    const pathSep = getPathSeparator(shell);
-    return dir.endsWith(pathSep) || path.dirname(dir) == "." ? dir : addPathSeparator(path.dirname(dir), shell);
-};
-// nu fully re-writes the prompt every keystroke resulting in duplicate start/end sequences on the same line & re-writes the prompt after accepting a command
-// xonsh re-writes the prompt after accepting a command
-export const getShellPromptRewrites = (shell) => shell == Shell.Nushell || shell == Shell.Xonsh;
-export const getShellSourceCommand = (shell) => {
-    switch (shell) {
-        case Shell.Bash:
-            return `[ -f ~/.inshellisense/bash/init.sh ] && source ~/.inshellisense/bash/init.sh`;
-        case Shell.Powershell:
-            return `if ( Test-Path '~/.inshellisense/powershell/init.ps1' -PathType Leaf ) { . ~/.inshellisense/powershell/init.ps1 }`;
-        case Shell.Pwsh:
-            return `if ( Test-Path '~/.inshellisense/pwsh/init.ps1' -PathType Leaf ) { . ~/.inshellisense/pwsh/init.ps1 }`;
-        case Shell.Zsh:
-            return `[[ -f ~/.inshellisense/zsh/init.zsh ]] && source ~/.inshellisense/zsh/init.zsh`;
-        case Shell.Fish:
-            return `test -f ~/.inshellisense/fish/init.fish && source ~/.inshellisense/fish/init.fish`;
-        case Shell.Xonsh:
-            return `p"~/.inshellisense/xonsh/init.xsh".exists() && source "~/.inshellisense/xonsh/init.xsh"`;
-        case Shell.Nushell:
-            return `if ( '~/.inshellisense/nu/init.nu' | path exists ) { source ~/.inshellisense/nu/init.nu }`;
-    }
-    return "";
-};
-export const getShellConfig = (shell) => {
-    switch (shell) {
-        case Shell.Zsh:
-            return `if [[ -z "\${ISTERM}" && $- = *i* && $- != *c* && -z "\${VSCODE_RESOLVING_ENVIRONMENT}" ]]; then
-  if [[ -o login ]]; then
-    is -s zsh --login ; exit
-  else
-    is -s zsh ; exit
-  fi
-fi`;
-        case Shell.Bash:
-            return `if [[ -z "\${ISTERM}" && $- = *i* && $- != *c* && -z "\${VSCODE_RESOLVING_ENVIRONMENT}" ]]; then
-  shopt -q login_shell
-  login_shell=$?
-  if [ $login_shell -eq 0 ]; then
-    is -s bash --login ; exit
-  else
-    is -s bash ; exit
-  fi 
-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 -and [string]::IsNullOrEmpty($env:VSCODE_RESOLVING_ENVIRONMENT)) {
-  is -s ${shell}
-  Stop-Process -Id $pid
-}`;
-        case Shell.Fish:
-            return `if test -z "$ISTERM" && status --is-interactive && test -z "$VSCODE_RESOLVING_ENVIRONMENT"
-  if status --is-login
-    is -s fish --login ; kill %self
-  else
-    is -s fish ; kill %self
-  end 
-end`;
-        case Shell.Xonsh:
-            return `if 'ISTERM' not in \${...} and $XONSH_INTERACTIVE and 'VSCODE_RESOLVING_ENVIRONMENT' not in \${...}:
-    if $XONSH_LOGIN:
-        is -s xonsh --login ; exit
-    else:
-        is -s xonsh ; exit`;
-        case Shell.Nushell:
-            return `if "ISTERM" not-in $env and $nu.is-interactive and "VSCODE_RESOLVING_ENVIRONMENT" not-in $env {
-    if $nu.is-login { is -s nu --login ; exit } else { is -s nu ; exit }
-}`;
-    }
-    return "";
-};

package/build/utils/version.js

@@ -1,13 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-import url from "node:url";
-import path from "node:path";
-import fsAsync from "node:fs/promises";
-const __filename = url.fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-export const getVersion = async () => {
-    const packageJsonPath = path.join(__dirname, "..", "..", "package.json");
-    const packageJson = await fsAsync.readFile(packageJsonPath, { encoding: "utf-8" });
-    const packageJsonParsed = JSON.parse(packageJson);
-    return packageJsonParsed.version;
-};

package/scripts/postinstall.js

@@ -1,9 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-import fs from "node:fs";
-
-if (fs.existsSync("./build/commands/init.js")) {
-  const init = (await import("../build/commands/init.js")).default;
-  init.parse(["--generate-full-configs"], { from: "user" });
-}