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 网页版中打开,并显示已导入的配置文件内容。您可以根据需要取消选择某些配置文件元素,如果您想在 VS Code 网页版中继续使用该配置文件,则需要手动安装扩展(通过云下载按钮)。
您还可以选择在 Visual Studio Code 中导入配置文件,这将打开 VS Code 桌面版,其中显示了配置文件内容以及一个导入配置文件按钮。
您可以在 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 - 智能感知、环境管理、调试、重构。
- Python Environments - 使用您偏好的环境管理器管理 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 notebooks。
- Python - 智能感知、环境管理、调试、重构。
- 远程开发扩展包 - 支持 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
}
文档编写配置文件模板
文档编写配置文件是编写文档的良好轻量级设置。它包含以下扩展
- Code Spell Checker - 源代码拼写检查器。
- Markdown Checkboxes - 为 VS Code 内置的 Markdown 预览添加复选框支持。
- Markdown Emoji - 为 Markdown 预览和 notebook Markdown 单元格添加表情符号语法支持。
- Markdown Footnotes - 为 Markdown 预览添加 ^footnote 语法支持。
- Markdown Preview GitHub Styling - 在 Markdown 预览中使用 GitHub 样式。
- Markdown Preview Mermaid Support - Mermaid 图和流程图。
- Markdown yaml Preamble - 将 YAML front matter 渲染为表格。
- 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 中。
- 开发容器 (Dev Containers) - 在 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 工具。
- npm Intellisense - 在 import 语句中自动补全 npm 模块。
- Prettier - 代码格式化工具 - 使用 Prettier 的代码格式化工具。
- Rest Client - Visual Studio Code 的 REST 客户端。
- YAML - YAML 语言支持,内置 Kubernetes 语法。
此配置文件包含以下设置
"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 schematics(CLI 命令)。
- angular2-switcher - 在 angular2 项目中轻松导航到
typescript
|template
|style
。 - 开发容器 (Dev Containers) - 在 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 工具。
- Playwright Test for VSCode - 在 Visual Studio Code 中运行 Playwright 测试。
- Prettier - 代码格式化工具 - 使用 Prettier 的代码格式化工具。
- Rest Client - Visual Studio Code 的 REST 客户端。
- YAML - YAML 语言支持,内置 Kubernetes 语法。
此配置文件设置了以下设置
"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 的代码示例。
- Red Hat 的 Java(TM) 语言支持 - 提供基础 Java 语言支持、代码检查、智能感知、格式化、重构功能。
- Java 的 Maven - 管理 Maven 项目和构建。
- Java 项目管理器 - 在 VS Code 中管理 Java 项目。
- 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 会为您的工作区重新启用当前配置文件。
我可以从另一个配置文件继承设置吗?
目前,无法从另一个配置文件继承设置,即覆盖特定设置并保留来自另一个配置文件的其余设置。我们正在 vscode 仓库中跟踪此功能请求。
创建新配置文件时,您可以选择从另一个配置文件或默认配置文件复制设置。这会在新配置文件中创建设置的副本,但不会保留与作为源使用的配置文件的链接。
如何从项目中移除配置文件?
您可以将项目设置回默认配置文件。如果您想移除所有配置文件的与工作区的关联,可以使用开发人员: 重置工作区配置文件关联,这将把当前已分配配置文件的所有本地文件夹重置回默认配置文件。重置工作区配置文件关联不会删除任何现有配置文件。
导出配置文件时,为什么某些设置未导出?
导出配置文件时,不包含特定于计算机的设置,因为这些设置在另一台计算机上不适用。例如,指向本地路径的设置不包括在内。
创建新配置文件时,为什么模板不可用?
配置文件模板由 VS Code 外部托管,您只有在连接到互联网时才能下载和应用模板。如果您注意到配置文件模板不可用,请务必检查您的互联网连接。