现已推出!阅读有关 11 月份新功能和修复的信息。

终端配置文件

终端配置文件是特定于平台的 shell 配置,由可执行路径、参数和其他自定义项组成。默认情况下,会自动检测到多个配置文件,这些配置文件可以自定义或添加。

配置文件示例

{
  "terminal.integrated.profiles.windows": {
    "Custom Init": {
      "path": "pwsh.exe",
      "args": [
         "-noexit",
         "-file",
         "${env:APPDATA}\\PowerShell\\custom-init.ps1"
      ]
    }
  },
  "terminal.integrated.defaultProfile.windows": "Custom Init"
}

你可以在终端配置文件中使用变量,如上面的示例所示,其中使用了 APPDATA 环境变量。在变量参考主题中提供了可用变量的列表。

通过运行 终端:选择默认配置文件 命令配置默认配置文件,也可以通过新的终端下拉菜单访问该命令。

Select Default Profile is located at the bottom of the dropdown menu attached to the new terminal button

默认终端配置文件 shell 在 Linux 和 macOS 上默认为 $SHELL,在 Windows 上默认为 PowerShell。VS Code 将自动检测大多数标准 shell,然后可以将其配置为默认值。

配置配置文件

要创建新的配置文件,请运行 终端:选择默认配置文件 命令,并激活 shell 右侧的配置按钮以基于它。这将向你的设置中添加一个新条目,可以在你的 settings.json 文件中手动调整。

可以使用 pathsource 以及一组可选参数创建配置文件。source 仅在 Windows 上可用,可用于让 VS Code 检测 PowerShellGit Bash 的安装。或者,可以使用直接指向 shell 可执行文件的 path。以下是一些配置文件示例:

{
  "terminal.integrated.profiles.windows": {
    "PowerShell -NoProfile": {
      "source": "PowerShell",
      "args": ["-NoProfile"]
    }
  },
  "terminal.integrated.profiles.linux": {
    "zsh (login)": {
      "path": "zsh",
      "args": ["-l"]
    }
  }
}

配置文件中支持的其他参数包括:

  • overrideName:一个布尔值,指示是否要将动态终端标题(该标题检测正在运行的程序)替换为静态配置文件名称。
  • env:一个定义环境变量及其值的映射,将变量设置为 null 以将其从环境中删除。可以使用 terminal.integrated.env.<platform> 设置为所有配置文件配置此项。
  • icon:要用于配置文件的图标 ID。
  • color:用于设置图标样式的色主题 ID。

提示:Path、args 和 env 都支持解析变量

可以使用 terminal.integrated.defaultProfile.* 设置手动定义默认配置文件。应将其设置为现有配置文件的名称。

{
  "terminal.integrated.profiles.windows": {
    "my-pwsh": {
      "source": "PowerShell",
      "args": ["-NoProfile"]
    }
  },
  "terminal.integrated.defaultProfile.windows": "my-pwsh"
}

提示:集成终端 shell 以 VS Code 的权限运行。如果你需要使用提升的(管理员)权限或不同的权限运行 shell 命令,请使用平台实用程序,例如终端内的 runas.exe

删除内置配置文件

要删除内置配置文件并防止它显示在新终端下拉菜单中,请将配置文件的名称设置为 null。例如,要删除 Windows 上的 Git Bash 配置文件,请使用此设置:

{
  "terminal.integrated.profiles.windows": {
    "Git Bash": null
  }
}

配置任务/调试配置文件

默认情况下,任务/调试功能将使用默认配置文件。如果你的默认配置文件具有繁重的 PowerShell 启动脚本或不符合 POSIX 的 shell,这可能不是理想的选择。要配置仅在调试/任务功能中使用的配置文件,请使用 terminal.integrated.automationProfile.<platform> 设置:

{
  "terminal.integrated.defaultProfile.osx": "fish",
  // Use a fully POSIX-compatible shell and avoid running a complex ~/.config/fish/config.fish
  // for tasks and debug
  "terminal.integrated.automationProfile.osx": {
    "path": "/bin/sh"
  }
}

特定于配置文件的按键绑定

可以使用 workbench.action.terminal.newWithProfile 命令通过专用按键绑定启动具有特定配置文件的终端。此命令采用配置文件名称和可选位置作为参数。例如,要将 Ctrl+Shift+T 绑定到使用 zsh 配置文件打开终端:

{
  "key": "ctrl+shift+t",
  "command": "workbench.action.terminal.newWithProfile",
  "args": {
    "profileName": "zsh",
    "location": "editor"
  }
}

不安全的配置文件检测

某些 shell 默认安装在不安全的路径中,例如 Windows 环境中其他用户可以写入的路径。VS Code 仍会检测到这些 shell,但除非它们已通过 终端:选择默认配置文件 命令显式配置,否则不会将其公开为正确的配置文件。在配置不安全的配置文件时,添加之前会出现警告:

Shells with unsafe paths like c:\msys64 will show a warning before you can use the detected profile

Cmder

Cmder 本身是一个终端,但你可以在 VS Code 中使用Cmder shell 以及以下配置文件:

{
  "terminal.integrated.profiles.windows": {
    "cmder": {
      "path": "C:\\WINDOWS\\System32\\cmd.exe",
      "args": ["/K", "C:\\cmder\\vendor\\bin\\vscode_init.cmd"]
    }
  },
  "terminal.integrated.defaultProfile.windows": "cmder"
}

设置 CMDER_ROOT 环境变量后,应自动选取此配置文件。如果安装在 C:\cmder 中,它也将被检测为不安全的配置文件。你可能需要参考 Cmder 的 wiki 以了解更多信息。

Cygwin

Cygwin 本身是一个终端,但你可以在 VS Code 中使用Cygwin shell 以及以下配置文件:

{
  "terminal.integrated.profiles.windows": {
    "Cygwin": {
      "path": "C:\\cygwin64\\bin\\bash.exe",
      "args": ["--login"]
    }
  },
  "terminal.integrated.defaultProfile.windows": "Cygwin"
}

当安装在默认路径 C:\cygwinC:\cygwin64 时,应自动将此配置文件检测为不安全的配置文件

Git Bash

当 VS Code 使用 bash.exe(shell)而不是 git-bash.exe(终端)时,Git Bash 的一个限制是在 shell 会话之间不会保留历史记录。你可以通过将以下内容添加到你的 ~/.bashrc~/.bash_profile 文件来解决此问题:

export PROMPT_COMMAND='history -a'

这将导致 shell 在打印提示符时调用 history -a,这会将会话的当前会话命令刷新到后备历史记录文件。

MSYS2

可以使用以下配置文件配置 MSYS2 的 bash shell:

{
  "terminal.integrated.profiles.windows": {
    "bash (MSYS2)": {
      "path": "C:\\msys64\\usr\\bin\\bash.exe",
      "args": ["--login", "-i"],
      "env": { "CHERE_INVOKING": "1" }
    }
  }
}

使用CHERE_INVOKING 环境变量来告诉登录初始化脚本保留工作目录,而不是在 $HOME 中打开。

当安装在默认路径 C:\\msys64 时,应自动将此配置文件检测为不安全的配置文件

Windows PowerShell

安装 PowerShell 6+ 后,默认情况下 Windows PowerShell 不会包含在配置文件列表中。要将 Windows PowerShell 添加为配置文件,请在新终端下拉菜单中选择 选择默认配置文件 选项,然后选择 Windows PowerShell 项。这将配置配置文件并将其设置为你的默认值。

WSL

在本地计算机上运行 VS Code 时,应该会自动检测到适用于 Linux 的 Windows 子系统 (WSL) shell。根据您的设置,如果您安装了大量发行版,这可能会造成不便。要更精细地控制 WSL 配置文件,可以使用 terminal.integrated.useWslProfiles 设置禁用自动检测,以下是如何手动配置 WSL shell 的示例

{
  "terminal.integrated.profiles.windows": {
    "Debian (WSL)": {
      "path": "C:\\WINDOWS\\System32\\wsl.exe",
      "args": [
        "-d",
        "Debian"
      ]
    }
  }
}

常见问题

为什么终端的 $PATH 环境变量中存在重复路径?或者为什么它们在 macOS 上反转了?

这可能发生在 macOS 上,因为终端启动时使用了 VS Code 的环境。当 VS Code 首次启动以获取您的“开发环境”时,它会以登录 shell 的形式启动您配置的 shell,这会运行您的 ~/.profile/~/.bash_profile/~/.zprofile 脚本。现在,当终端启动时,它也作为登录 shell 运行,这将把标准路径放在前面(例如,/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin)并重新初始化您的 shell 环境。

为了更好地理解,您可以通过在操作系统的内置终端中启动内部登录 shell 来模拟正在发生的情况

# Add /test to the beginning of $PATH
export PATH=/test:$PATH
# Echo $PATH, /test should be at the beginning
echo $PATH
# Run bash as a login shell
bash -l
# Echo $PATH, the values should be jumbled
echo $PATH

不幸的是,与 Linux 不同,独立的 macOS 终端默认都作为登录 shell 运行,因为 macOS 在用户登录系统时不会运行登录 shell。这鼓励了“不良行为”,例如在您的配置文件脚本中初始化别名,而这些别名应该放在您的 rc 脚本中,因为该脚本会在非登录 shell 上运行。

对此有两种直接的修复方法。第一种是将 "terminal.integrated.inheritEnv": false 设置为禁用,这将从终端的环境中删除大多数环境变量,除了某些重要的变量(如 HOMESHELLTMPDIR 等)。

另一种修复方法是在终端中不再运行登录 shell,方法是创建一个终端配置文件并将其 args 设置为 []。如果您选择这种修复方法,您需要确保将配置文件脚本中的任何别名移动到您的 ~/.bashrc/~/.zshrc 文件中,因为别名仅适用于它们所在的 shell。