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、开发容器或 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 文档字符串。
- Container Tools - 创建、管理和调试容器化应用程序。
- Even Better TOML - 对例如
pyproject.toml
文件提供功能齐全的 TOML 支持。 - Python - 智能感知、环境管理、调试、重构。
- Python Environments - 使用你偏好的环境管理器管理 Python 环境和包。
- Remote Development 扩展包 - 支持 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 - 智能感知、环境管理、调试、重构。
- Remote Development 扩展包 - 支持 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 预览和笔记本 Markdown 单元格添加表情符号语法支持。
- Markdown Footnotes - 为 Markdown 预览添加 ^footnote 语法支持。
- Markdown Preview GitHub Styling - 在 Markdown 预览中使用 GitHub 样式。
- Markdown Preview Mermaid Support - Mermaid 图和流程图。
- Markdown yaml Preamble - 将 YAML 前置内容渲染为表格。
- markdownlint - Visual Studio Code 的 Markdown Linting 和样式检查。
- Word Count - 在状态栏中查看 Markdown 文档的字数。
- Read Time - 估计阅读您的 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 工作的良好起点。它附带以下扩展:
- Container Tools - 创建、管理和调试容器化应用程序。
- Dev Containers - 在 Docker 容器中创建自定义开发环境。
- DotENV - 支持 dotenv 文件语法。
- EditorConfig for VS Code - Visual Studio Code 的 EditorConfig 支持。
- ESLint - 将 ESLint JavaScript 集成到 VS Code 中。
- JavaScript (ES6) code snippets - ES6 语法中的 JavaScript 代码片段。
- Jest - 使用 Facebook 的 jest 测试框架。
- Microsoft Edge Tools for VS Code - 在 VS Code 中使用 Microsoft Edge 工具。
- npm Intellisense - 在 import 语句中自动完成 npm 模块。
- Prettier - Code formatter - 使用 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 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) code snippets - 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 - Code formatter - 使用 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 扩展包中的以下扩展:
- Debugger for Java - 轻量级 Java 调试器。
- IntelliCode - AI 辅助开发。
- IntelliCode API Usage Examples - 为超过 10 万个不同的 API 提供代码示例。
- Language Support for Java(TM) by Red Hat - 基本 Java 语言支持、Linting、智能感知、格式化、重构。
- 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
如果您使用的是内部版本,中间文件夹名称是 Code - Insiders
。
什么是临时配置文件?
临时配置文件是不跨 VS Code 会话保存的配置文件。你可以通过命令面板中的配置文件: 创建临时配置文件命令创建临时配置文件。临时配置文件以空配置文件开始,并具有自动生成的名称(例如Temp 1)。你可以修改配置文件设置和扩展,在 VS Code 会话的整个生命周期中使用该配置文件,但一旦你关闭 VS Code,它将被删除。
如果您想尝试新配置或测试扩展而不修改默认或现有配置文件,则临时配置文件会很有用。重新启动 VS Code 将重新启用工作区的当前配置文件。
我能从另一个配置文件继承设置吗?
目前,无法从另一个配置文件继承设置,即覆盖特定设置并保留其他配置文件中的其余设置。我们正在vscode 仓库中跟踪此功能请求。
当你创建新配置文件时,你可以选择从另一个或默认配置文件复制设置。这会在新配置文件中创建设置副本,但不会保持与作为源的配置文件的链接。
如何从我的项目中删除配置文件?
您可以将项目恢复到默认配置文件。如果您想删除所有配置文件工作区关联,可以使用开发人员: 重置工作区配置文件关联,这将把当前分配了配置文件的所有本地文件夹都重置回默认配置文件。重置工作区配置文件关联不会删除任何现有配置文件。
导出配置文件时,为什么有些设置没有导出?
导出配置文件时,特定于机器的设置不包括在内,因为这些设置在另一台机器上不适用。例如,指向本地路径的设置不包括在内。
为什么创建新配置文件时模板不可用?
配置文件模板由 VS Code 外部托管,你只能在连接到互联网时下载和应用模板。如果你发现配置文件模板不可用,请务必检查你的互联网连接。