现已推出!阅读 10 月份的新功能和修复。

Visual Studio Code 中的配置文件

Visual Studio Code 有数百种 设置、数千种 扩展 以及无数种调整 UI 布局以自定义编辑器的方式。VS Code **配置文件** 允许您创建自定义设置集,并在它们之间快速切换或与他人共享。本主题解释如何使用 **配置文件编辑器** 创建、修改、导出和导入配置文件。

访问配置文件编辑器

**配置文件编辑器** 允许您在一个地方创建和管理 VS Code 中的配置文件。

Screenshot that shows the Profiles editor.

您可以通过以下任一方式访问配置文件编辑器

  • 文件 > 首选项 > 配置文件 菜单项

    Profiles editor Menu Item

  • 从活动栏底部的 **管理** 齿轮按钮。

    Profiles editor via the Manage button in the Activity bar

创建配置文件

VS Code 将您的当前配置视为 **默认配置文件**。当您修改设置、安装扩展或通过移动视图更改 UI 布局时,这些自定义设置将在默认配置文件中进行跟踪。

要创建新配置文件,请打开配置文件编辑器并选择 **新建配置文件** 按钮。这将打开新建配置文件窗体,您可以在其中输入配置文件名称、选择图标以及配置新配置文件中包含的内容。

Create Profile

您可以选择通过从配置文件模板或现有配置文件复制内容来创建新配置文件,或者创建 **空配置文件**。空配置文件不包含任何用户自定义设置,例如设置、扩展、代码片段等。

Copy from options

您可以将新配置文件限制为仅包含配置子集(设置、键盘快捷键、代码片段、任务和扩展),并使用默认配置文件中的其余配置。例如,您可以创建一个包含所有配置的配置文件,但键盘快捷键除外,当此配置文件处于活动状态时,VS Code 将应用默认配置文件中的键盘快捷键。

您可以在 **内容** 部分浏览要从中复制的模板或配置文件的内容。每个部分旁边都有一个 **打开** 按钮,您可以选择该按钮查看其内容。

Configure, browse and preview profile

通过选择 **预览** 按钮在创建新配置文件之前预览它。这将打开一个新的 VS Code 窗口,其中应用了新配置文件。当您对预览感到满意后,可以选择 **创建** 按钮来创建新配置文件。

检查当前配置文件

您可以在 VS Code UI 的多个地方找到 VS Code 窗口当前正在使用的配置文件

  • 在 VS Code 标题栏中

  • 当您将鼠标悬停在活动栏中的 **管理** 按钮上时,在悬停文本中

    如果您已为配置文件配置图标,则此图标将用作活动栏中的 **管理** 按钮。请注意以下屏幕截图中,管理按钮现在具有麦克风图标,表示配置文件处于活动状态。

    Manage gear displaying icon to indicate that the user's profile is active

    如果您尚未配置图标,则 **管理** 齿轮按钮会显示一个带有活动配置文件前两个字母的徽章,以便您可以快速查看正在运行的配置文件。

    Manage gear displaying 'DA' to indicate that the user's 'Data Science' profile is active

  • 在配置文件编辑器中

    Showing current profile in the Profiles editor

注意:如果您使用的是默认配置文件,则不会显示配置文件名称。

配置配置文件

您可以像更改任何 VS Code 配置一样配置配置文件。您可以安装/卸载/禁用扩展、更改设置以及调整编辑器的 UI 布局(例如,移动和隐藏视图)。当您应用这些更改时,它们将存储在当前活动的配置文件中。

文件夹和工作区关联

当您创建或选择配置文件时,它将与当前文件夹或工作区关联。每当您打开该文件夹时,工作区的配置文件将变为活动状态。如果您打开另一个文件夹,则配置文件将更改为该文件夹的配置文件(如果已设置)。

您可以在 **配置文件编辑器** 的 **文件夹和工作区** 部分查看与配置文件关联的文件夹列表。

Folders & Workspaces section

管理配置文件

切换配置文件

您可以使用命令面板中的 **配置文件:切换配置文件** 命令在配置文件之间快速切换,该命令将显示一个包含可用配置文件的下拉列表。

您也可以从 **配置文件编辑器** 中切换配置文件,方法是选择要切换到的配置文件旁边的 **将此配置文件用于当前窗口** 按钮。

Switch profile from the Profiles editor

编辑配置文件

您可以在 **配置文件编辑器** 中编辑现有配置文件的名称、图标和其他配置。

删除配置文件

您可以通过在要删除的配置文件的溢出操作中选择 **删除配置文件** 按钮,从 **配置文件编辑器** 中删除配置文件。

Delete profile from the Profiles editor

您还可以通过 **删除配置文件** 命令删除配置文件。**删除配置文件** 下拉菜单允许您选择要删除的配置文件。

使用配置文件打开新窗口

您可以使用 **配置文件编辑器** 中的配置文件内容视图中提供的 **用于新窗口** 选项,在打开新的 VS Code 窗口时选择要使用的配置文件。

Configure custom profile for new window

您可以通过使用 **文件** > **使用配置文件打开新窗口** 菜单并选择要使用的配置文件,直接为特定配置文件打开新的 VS Code 窗口。

将设置应用于所有配置文件

要在所有配置文件中应用设置,请在设置编辑器中使用 **将设置应用于所有配置文件** 操作。

Apply setting to all Profiles

来自任何配置文件的此设置的更新也会应用于所有其他配置文件。您始终可以通过取消选中 **将设置应用于所有配置文件** 操作来恢复此行为。

将扩展应用于所有配置文件

要在所有配置文件中应用扩展,请在扩展视图中选择 **将扩展应用于所有配置文件** 操作。

Apply an extension to all Profiles

这将使此扩展在所有配置文件中可用。您始终可以通过取消选中 **将扩展应用于所有配置文件** 操作来恢复此行为。

跨机器同步配置文件

您可以使用 设置同步 将配置文件移动到不同的机器上。启用设置同步并在 **设置同步:配置** 下拉菜单中选中 **配置文件** 后,所有配置文件都将在同步的机器上可用。

Settings Sync data drop down with Profiles checked

注意: VS Code 不会将你的扩展同步到或从 远程 窗口,例如当你连接到 SSH、开发容器 (devcontainer) 或 WSL 时。

共享配置文件

导出

你可以使用你要导出的配置文件的溢出操作中的导出...按钮,导出配置文件以保存或与他人共享。

Export profile from the Profiles editor

当你选择导出...时,系统会提示你输入配置文件名称,以及你是否要导出到 GitHub gist 还是本地文件系统。

保存为 GitHub gist

将配置文件保存到 GitHub 后(系统会提示你登录 GitHub),会弹出一个对话框,让你可以选择复制链接以与他人共享你的配置文件 gist 的 URL。该 URL 包含一个自动生成的 GUID,格式为 https://vscode.dev/editor/profile/github/{GUID}。GitHub gist 被标记为私密,因此只有拥有链接的人才能看到 gist。

如果你启动配置文件 URL,它将在 VS Code for the Web 中打开,配置文件编辑器处于打开状态,并显示导入的配置文件内容。如果你愿意,可以取消选择配置文件元素,并且你需要手动安装扩展(通过下载云按钮),如果你想继续在 VS Code for the Web 中使用该配置文件。

你还可以选择在 Visual Studio Code 中导入配置文件,这将打开 VS Code 桌面,显示配置文件的内容和导入配置文件按钮。

你可以在 https://gist.github.com/{username} 查看你的 gist。从你的 GitHub gist 页面,你可以重命名、删除或复制 gist 的 GUID。

保存为本地文件

如果你选择将配置文件保存为本地文件,保存配置文件对话框会让你将文件放在本地计算机上。配置文件会以 .code-profile 扩展名保存到文件中。

导入

你可以通过选择配置文件编辑器中的导入配置文件...按钮(位于新建配置文件按钮的下拉操作中)来导入现有的配置文件。

Import profile from the Profiles editor

当你选择导入配置文件...时,系统会提示你通过导入配置文件对话框输入 GitHub gist 的 URL 或配置文件的文件位置。选择配置文件后,配置文件创建表单 将打开,并预先选择要导入的配置文件。你可以继续修改配置文件,然后选择创建以导入配置文件。

配置文件的用途

配置文件是自定义 VS Code 以更好地满足你需求的一种好方法。在本节中,我们将介绍一些配置文件的常见用例。

由于配置文件是按工作区记录的,因此它们是自定义 VS Code 以适应特定编程语言的一种好方法。例如,你可以创建一个 JavaScript 前端配置文件,其中包含你在一个工作区中用于 JavaScript 开发的扩展、设置和自定义内容,还可以创建一个 Python 后端配置文件,其中包含你在另一个工作区中用于 Python 开发的扩展、设置和自定义内容。使用这种方法,你可以轻松地在工作区之间切换,并始终使 VS Code 配置正确。

演示

在进行演示时,你可以使用配置文件为你的演示设置特定的配置。例如,你可以创建一个配置文件,其中包含一组特定的扩展和设置,例如缩放级别、字体大小和颜色主题。这样,演示就不会弄乱你正常的 VS Code 设置,你可以在演示过程中自定义 VS Code 以提高可见性。

教育

配置文件可用于自定义 VS Code,以便学生在课堂环境中更容易使用。配置文件使教育工作者能够快速地与学生共享自定义的 VS Code 设置。例如,教育工作者可以创建一个包含特定扩展和设置的配置文件,这些扩展和设置是计算机科学课程所需的,然后与学生共享该配置文件。

报告 VS Code 问题

空配置文件的一种用途是在你想要报告 VS Code 问题时重置编辑器。空配置文件会禁用所有扩展和修改的设置,以便你可以快速查看问题是由于扩展、设置还是 VS Code 核心造成的。

配置文件模板

VS Code 附带一组预定义的配置文件模板,你可以使用它们来自定义 VS Code 以适应你的特定工作流程。要根据模板创建新的配置文件,请在执行创建配置文件流程时选择配置文件模板。

Python 配置文件模板

Python 配置文件是 Python 开发的良好起点。它附带了 Python 特定的代码片段,并包含以下扩展

此配置文件还设置以下设置

    "python.analysis.autoImportCompletions": true,
    "python.analysis.fixAll": ["source.unusedImports"],
    "editor.defaultFormatter": "ms-python.black-formatter"

数据科学配置文件模板

数据科学配置文件是所有数据和笔记本工作的一个良好起点。它附带了特定代码片段,并包含以下扩展

  • 数据整理程序 - 用于表格数据集和 Excel/CSV/Parquet 文件的数据查看、清理和准备。
  • Black 格式化程序 - 使用 black 格式化程序提供格式化支持。
  • Jupyter - 在 VS Code 中使用 Jupyter 笔记本。
  • Python - IntelliSense、代码整理、格式化、调试、重构。
  • Dev Containers - 在 Docker 容器中创建自定义开发环境。
  • GitHub Copilot - 你的 AI 结对编程伙伴。

此配置文件还设置以下设置

    "[python]": {
        "editor.defaultFormatter": "ms-python.black-formatter",
        "editor.formatOnType": true,
        "editor.formatOnSave": true
    },
    "editor.inlineSuggest.enabled": true,
    "editor.lineHeight": 17,
    "breadcrumbs.enabled": false,
    "files.autoSave": "afterDelay",
    "jupyter.themeMatplotlibPlots": true,
    "jupyter.widgetScriptSources": [
        "unpkg.com",
        "jsdelivr.com"
    ],
    "notebook.experimental.outputScrolling": true,
    // "notebook.outline.showCodeCells": true,
    "files.exclude": {
        "**/.csv": true,
        "**/.parquet": true,
        "**/.pkl": true,
        "**/.xls": true
    }

文档编写者配置文件模板

文档编写者配置文件是编写文档的一个很好的轻量级设置。它附带了以下扩展

此配置文件还设置以下设置

    "workbench.colorTheme": "Default Light Modern",
    "editor.minimap.enabled": false,
    "breadcrumbs.enabled": false,
    "editor.glyphMargin": false,
    "explorer.decorations.badges": false,
    "explorer.decorations.colors": false,
    "editor.fontLigatures": true,
    "files.autoSave": "afterDelay",
    "git.enableSmartCommit": true,
    "window.commandCenter": true,
    "editor.renderWhitespace": "none",
    "workbench.editor.untitled.hint": "hidden",
    "markdown.validate.enabled": true,
    "markdown.updateLinksOnFileMove.enabled": "prompt",
    "workbench.startupEditor": "none"

Node.js 配置文件模板

Node.js 配置文件是所有 Node.js 工作的良好起点。它附带了以下扩展

此配置文件附带以下设置

    "editor.formatOnPaste": true,
    "git.autofetch": true,
    "[markdown]":  {
        "editor.wordWrap": "on"
    },
    "[json]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "[jsonc]": {
        "editor.defaultFormatter": "vscode.json-language-features"
    },
    "[html]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "[javascript]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "[typescript]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    }

Angular 配置文件模板

Angular 配置文件是所有 Angular 工作的良好起点。它附带了以下扩展

此配置文件设置以下设置

    "editor.formatOnPaste": true,
    "git.autofetch": true,
    "[markdown]":  {
        "editor.wordWrap": "on"
    },
    "[json]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "[jsonc]": {
        "editor.defaultFormatter": "vscode.json-language-features"
    },
    "[html]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "[javascript]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "[typescript]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "workbench.iconTheme": "material-icon-theme"

Java 通用配置文件模板

Java 通用配置文件是所有 Java 工作的良好起点。它自定义了布局以改善 Java 体验,并附带了来自 Java 扩展包 的以下扩展

Java Spring 配置文件模板

Java Spring 配置文件是所有 Java 和 Spring 开发人员的良好起点。它构建在 Java 通用配置文件的基础上,并从 Spring Boot 扩展包 中添加了以下扩展。

此配置文件设置以下设置

    "[java]": {
        "editor.defaultFormatter": "redhat.java"
    },
    "boot-java.rewrite.reconcile": true

命令行

您可以使用 --profile 命令行界面选项启动 VS Code,并使用特定配置文件。您在 --profile 参数之后传递配置文件的名称,并使用该配置文件打开文件夹或工作区。以下命令行使用“Web 开发”配置文件打开 web-sample 文件夹。

code ~/projects/web-sample --profile "Web Development"

如果指定的配置文件不存在,则会创建一个具有给定名称的新空配置文件。

常见问题

配置文件保存在哪里?

配置文件与用户设置和键绑定类似,存储在您的用户配置下。

  • Windows %APPDATA%\Code\User\profiles
  • macOS $HOME/Library/Application\ Support/Code/User/profiles
  • Linux $HOME/.config/Code/User/profiles

如果您使用的是 内部人员 版本,则中间文件夹名称为 Code - Insiders

什么是临时配置文件?

临时配置文件是在 VS Code 会话之间不会保存的配置文件。您可以通过命令面板中的配置文件:创建临时配置文件命令创建临时配置文件。临时配置文件从空配置文件开始,并具有自动生成的名称(例如Temp 1)。您可以修改配置文件设置和扩展,在 VS Code 会话期间使用配置文件,但它会在您关闭 VS Code 后被删除。

如果您想尝试新配置或测试扩展而无需修改默认配置文件或现有配置文件,则临时配置文件非常有用。重新启动 VS Code 会为您的工作区重新启用当前配置文件。

如何从我的项目中删除配置文件?

您可以将项目设置为默认配置文件。如果您想删除所有配置文件工作区关联,可以使用开发人员:重置工作区配置文件关联,这将使当前分配了配置文件的所有本地文件夹恢复为默认配置文件。重置工作区配置文件关联不会删除任何现有配置文件。

为什么导出配置文件时某些设置未导出?

导出配置文件时,不会包含特定于机器的设置,因为这些设置在其他机器上不适用。例如,指向本地路径的设置不会包含在内。

为什么创建新配置文件时模板不可用?

配置文件模板由 VS Code 在外部托管,您只能在连接到互联网时下载和应用模板。如果您发现配置文件模板不可用,请确保检查您的互联网连接。