Visual Studio Code 中的配置文件
Visual Studio Code 具有数百个设置、数千个扩展以及无数种调整 UI 布局以自定义编辑器的方式。VS Code 配置文件让您创建自定义设置集,并在它们之间快速切换或与他人共享。本主题介绍如何使用配置文件编辑器创建、修改、导出和导入配置文件。
访问配置文件编辑器
使用 配置文件编辑器 ,您可以从一个位置在 VS Code 中创建和管理您的配置文件。
您可以通过以下任一方式访问配置文件编辑器
-
从 文件 > 首选项 > 配置文件 菜单项
-
从活动栏底部的 管理 齿轮按钮。
创建配置文件
VS Code 将您当前的配置视为 默认配置文件 。当您修改设置、安装扩展或通过移动视图更改 UI 布局时,这些自定义设置将在默认配置文件中进行跟踪。
要创建新配置文件,请打开配置文件编辑器,然后选择 新建配置文件 按钮。这将打开“新建配置文件”表单,您可以在其中输入配置文件名称、选择图标,以及配置新配置文件中包含的内容。
您可以选择通过从配置文件模板或现有配置文件复制内容来创建新配置文件,或者创建 空配置文件 。空配置文件不包含任何用户自定义设置,例如设置、扩展、代码片段等。
您可以限制新配置文件仅包含配置的子集(设置、键盘快捷方式、代码片段、任务和扩展),并使用默认配置文件中的其余配置。例如,您可以创建一个包含除键盘快捷方式之外的所有配置的配置文件,当此配置文件处于活动状态时,VS Code 将应用默认配置文件中的键盘快捷方式。
您可以在 内容 部分中浏览要复制的模板或配置文件的内容。每个部分旁边都有一个 打开 按钮,您可以选择该按钮来查看其内容。
通过选择 预览 按钮,在创建新配置文件之前预览它。这将打开一个新的 VS Code 窗口,并将新配置文件应用于该窗口。如果您对预览感到满意,可以选择 创建 按钮来创建新配置文件。
检查当前配置文件
您可以在 VS Code UI 中的多个位置找到 VS Code 窗口当前正在使用的配置文件
-
在 VS Code 标题栏中
-
当您将鼠标悬停在活动栏中的 管理 按钮上时,在悬停文本中
如果您为配置文件配置了图标,则此图标将用作活动栏中的 管理 按钮。请注意,在以下屏幕截图中,“管理”按钮现在有一个麦克风图标,表明配置文件处于活动状态。
如果您未配置图标,则 管理 齿轮按钮将显示一个徽章,其中包含活动配置文件的前两个字母,以便您可以快速检查正在运行的配置文件。
-
在配置文件编辑器中
注意 :如果您使用的是默认配置文件,则不显示配置文件名称。
配置配置文件
您可以像更改任何 VS Code 配置一样配置配置文件。您可以安装/卸载/禁用扩展、更改设置以及调整编辑器的 UI 布局(例如,移动和隐藏视图)。当您应用这些更改时,它们将存储在您当前活动的配置文件中。
文件夹和工作区关联
当您创建或选择配置文件时,它会与当前文件夹或工作区关联。每当您打开该文件夹时,工作区的配置文件将变为活动状态。如果您打开另一个文件夹,则配置文件将更改为另一个文件夹的配置文件(如果已设置)。
您可以在 配置文件编辑器 的 文件夹和工作区 部分中查看与配置文件关联的文件夹列表。
管理配置文件
切换配置文件
您可以使用命令面板中的 配置文件:切换配置文件 命令快速在配置文件之间切换,该命令会显示一个下拉列表,列出您可用的配置文件。
您还可以从 配置文件编辑器 切换配置文件,方法是选择要切换到的配置文件旁边的 将此配置文件用于当前窗口 按钮。
编辑配置文件
您可以在 配置文件编辑器 中编辑现有配置文件的名称、图标和其他配置。
删除配置文件
您可以从 配置文件编辑器 中删除配置文件,方法是选择要删除的配置文件的溢出操作中的 删除配置文件 按钮。
您还可以通过 删除配置文件 命令删除配置文件。 删除配置文件 下拉列表允许您选择要删除的配置文件。
使用配置文件打开新窗口
您可以使用配置文件编辑器中“配置文件内容”视图中提供的 用于新窗口 选项,选择在打开新的 VS Code 窗口时使用的配置文件。
您可以使用 文件 > 使用配置文件新建窗口 菜单直接为特定配置文件打开新的 VS Code 窗口,然后选择要使用的配置文件。
将设置应用于所有配置文件
要将设置应用于您的所有配置文件,请使用设置编辑器中的 将设置应用于所有配置文件 操作。
从您的任何配置文件中对此设置进行的更新也会应用于所有其他配置文件。您始终可以通过取消选中 将设置应用于所有配置文件 操作来恢复此行为。
将扩展应用于所有配置文件
要将扩展应用于您的所有配置文件,请在“扩展”视图中选择 将扩展应用于所有配置文件 操作。
这将使此扩展在您的所有配置文件中可用。您始终可以通过取消选中 将扩展应用于所有配置文件 操作来恢复此行为。
跨机器同步配置文件
您可以使用 设置同步 在各种机器之间移动您的配置文件。启用“设置同步”并在 设置同步:配置 下拉列表中选中 配置文件 后,您的所有配置文件都将在同步的机器上可用。
注意 :VS Code 不会同步您的扩展到或从 远程 窗口,例如当您连接到 SSH、开发容器 (devcontainer) 或 WSL 时。
共享配置文件
导出
您可以使用要导出的配置文件的溢出操作中的 导出... 按钮导出配置文件,以便保存或与他人共享。
当您选择 导出... 时,系统会提示您输入配置文件名称,以及您是要导出到 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 Desktop,其中显示配置文件的内容以及 导入配置文件 按钮。
您可以在 https://gist.github.com/{username}
查看您的 gist。在您的 GitHub gist 页面中,您可以重命名、删除或复制 gist 的 GUID。
另存为本地文件
如果您选择将配置文件另存为本地文件,则 保存配置文件 对话框允许您将文件放置在本地计算机上。配置文件以扩展名 .code-profile
的文件形式持久保存。
导入
您可以通过选择 新建配置文件 按钮的下拉操作中的 导入配置文件... 按钮,从 配置文件编辑器 导入现有配置文件。
当您选择 导入配置文件... 时,系统会通过 导入配置文件 对话框提示您输入 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 特有的代码片段,并具有以下扩展
- autoDocstring - 自动生成 Python 文档字符串。
- Docker - 创建、管理和调试容器化应用程序。
- Even Better TOML - 功能齐全的 TOML 支持,例如
pyproject.toml
文件。 - Python - IntelliSense、环境管理、调试、重构。
- Python Environment Manager - 管理 Python 环境和包。
- 远程开发 扩展包 - 支持 SSH、WSL 和开发容器。
- Ruff - 集成 Ruff Python 代码检查器和格式化程序。
此配置文件还设置了以下设置
"python.analysis.autoImportCompletions": true,
"python.analysis.fixAll": ["source.unusedImports"],
"editor.defaultFormatter": "charliermarsh.ruff"
数据科学配置文件模板
数据科学配置文件是所有数据和笔记本工作的良好起点。它附带特定的代码片段,并具有以下扩展
- Data Wrangler - 用于表格数据集和 Excel/CSV/Parquet 文件的数据查看、清理和准备。
- GitHub Copilot - 您的 AI 结对程序员。
- Jupyter - 在 VS Code 中使用 Jupyter 笔记本。
- Python - IntelliSense、环境管理、调试、重构。
- 远程开发 扩展包 - 支持 SSH、WSL 和开发容器。
- Ruff - 集成 Ruff Python 代码检查器和格式化程序。
此配置文件还设置了以下设置
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.formatOnType": true,
"editor.formatOnSave": true
},
"editor.inlineSuggest.enabled": true,
"editor.lineHeight": 17,
"breadcrumbs.enabled": false,
"files.autoSave": "afterDelay",
"notebook.output.scrolling": true,
"jupyter.themeMatplotlibPlots": true,
"jupyter.widgetScriptSources": [
"unpkg.com",
"jsdelivr.com"
],
"files.exclude": {
"**/.csv": true,
"**/.parquet": true,
"**/.pkl": true,
"**/.xls": true
}
文档编写器配置文件模板
文档编写器配置文件是编写文档的良好轻量级设置。它附带以下扩展
- 代码拼写检查器 - 源代码的拼写检查器。
- Markdown 复选框 - 将复选框支持添加到 VS Code 内置 Markdown 预览。
- Markdown Emoji - 将表情符号语法支持添加到 Markdown 预览和笔记本 Markdown 单元格。
- Markdown 脚注 - 将 ^footnote 语法支持添加到 Markdown 预览。
- Markdown 预览 GitHub 样式 - 在 Markdown 预览中使用 GitHub 样式。
- Markdown 预览 Mermaid 支持 - Mermaid 图表和流程图。
- Markdown yaml Preamble - 将 YAML 头部呈现为表格。
- markdownlint - Visual Studio Code 的 Markdown 代码检查和样式检查。
- 字数统计 - 在状态栏中查看 Markdown 文档中的字数。
- 阅读时间 - 估计阅读 Markdown 所需的时间。
此配置文件还设置了以下设置
"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 工作的良好起点。它附带以下扩展
- ESLint - 将 ESLint JavaScript 集成到 VS Code 中。
- 开发容器 - 在 Docker 容器内创建自定义开发环境。
- Docker - 创建、管理和调试容器化应用程序。
- DotENV - 支持 dotenv 文件语法。
- EditorConfig for VS Code - Visual Studio Code 的 EditorConfig 支持。
- JavaScript (ES6) 代码片段 - ES6 语法中 JavaScript 的代码片段。
- Jest - 使用 Facebook 的 jest 测试框架。
- Microsoft Edge Tools for VS Code - 从 VS Code 中使用 Microsoft Edge Tools。
- npm Intellisense - 在导入语句中自动完成 npm 模块。
- Prettier - 代码格式化程序 - 使用 Prettier 的代码格式化程序。
- Rest Client - Visual Studio Code 的 REST 客户端。
- YAML - 具有内置 Kubernetes 语法的 YAML 语言支持。
此配置文件附带以下设置
"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 工作的良好起点。它附带以下扩展
- Angular Language Service - Angular 模板的编辑器服务。
- Angular Schematics - 集成 Angular 原理图(CLI 命令)。
- angular2-switcher - 在 angular2 项目中轻松导航到
typescript
|template
|style
。 - 开发容器 - 在 Docker 容器内创建自定义开发环境。
- EditorConfig for VS Code - Visual Studio Code 的 EditorConfig 支持。
- ESLint - 将 ESLint JavaScript 集成到 VS Code 中。
- JavaScript (ES6) 代码片段 - ES6 语法中 JavaScript 的代码片段。
- Jest - 使用 Facebook 的 jest 测试框架。
- Material Icon Theme - Visual Studio Code 的 Material Design 图标。
- Microsoft Edge Tools for VS Code - 从 VS Code 中使用 Microsoft Edge Tools。
- Playwright Test for VSCode - 在 Visual Studio Code 中运行 Playwright 测试。
- Prettier - 代码格式化程序 - 使用 Prettier 的代码格式化程序。
- Rest Client - Visual Studio Code 的 REST 客户端。
- YAML - 具有内置 Kubernetes 语法的 YAML 语言支持。
此配置文件设置了以下设置
"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 调试器 - 轻量级 Java 调试器。
- IntelliCode - AI 辅助开发。
- IntelliCode API 使用示例 - 为超过 10 万个不同的 API 提供代码示例。
- Language Support for Java(TM) by Red Hat - 基本 Java 语言支持、代码检查、Intellisense、格式化、重构。
- Maven for Java - 管理 Maven 项目和构建。
- Project Manager for Java - 在 VS Code 中管理 Java 项目。
- Test Runner for Java - 运行和调试 JUnit 或 TestNG 测试用例。
Java Spring 配置文件模板
Java Spring 配置文件是所有 Java 和 Spring 开发人员的良好起点。它基于 Java 通用配置文件构建,并添加了来自 Spring Boot 扩展包 的以下扩展
- Spring Boot Dashboard - 在您运行的 Spring 应用程序中提供 Spring Boot 实时数据可视化和观察。
- Spring Boot Tools - 为 Spring Boot 文件提供丰富的语言支持。
- Spring Initializr Java Support - 搭建和生成 Spring Boot Java 项目。
此配置文件设置了以下设置
"[java]": {
"editor.defaultFormatter": "redhat.java"
},
"boot-java.rewrite.reconcile": true
命令行
您可以通过 --profile
命令行界面选项使用特定配置文件启动 VS Code。您在 --profile
参数后传递配置文件的名称,并使用该配置文件打开文件夹或工作区。以下命令行使用“Web Development”配置文件打开 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
如果您使用的是 Insiders 版本,则中间文件夹名称为 Code - Insiders
。
什么是临时配置文件?
临时配置文件是在 VS Code 会话之间未保存的配置文件。您可以通过命令面板中的 配置文件:创建临时配置文件 命令创建临时配置文件。临时配置文件作为空配置文件启动,并具有自动生成的名称(例如 临时 1 )。您可以修改配置文件设置和扩展,在 VS Code 会话的生命周期内使用该配置文件,但在您关闭 VS Code 后,它将被删除。
如果您想尝试新配置或测试扩展而不修改默认或现有配置文件,临时配置文件很有用。重新启动 VS Code 会重新启用工作区的当前配置文件。
如何从我的项目中删除配置文件?
您可以将您的项目设置回默认配置文件。如果您想删除所有配置文件工作区关联,您可以使用 开发人员:重置工作区配置文件关联 ,这将将当前分配了配置文件的所有本地文件夹设置回默认配置文件。 重置工作区配置文件关联 不会删除任何现有配置文件。
为什么导出配置文件时某些设置未导出?
导出配置文件时,不包括特定于机器的设置,因为这些设置在另一台机器上不适用。例如,不包括指向本地路径的设置。
为什么创建新配置文件时模板不可用?
配置文件模板由 VS Code 外部托管,您只能在连接到互联网时下载和应用模板。如果您注意到配置文件模板不可用,请确保检查您的互联网连接。