多根工作区

您可以使用多根工作区在 Visual Studio Code 中处理多个项目文件夹。当您同时处理多个相关项目时，这会很有帮助。例如，您可能有一个包含产品文档的存储库，您希望在更新产品源代码时保持该文档的最新状态。

注意：如果您想了解有关 VS Code “工作区”概念的更多信息，可以查看什么是 VS Code “工作区”？ 除非您显式创建多根工作区，否则“工作区”只是您项目的单个根文件夹。

添加文件夹

将另一个文件夹添加到现有工作区非常容易。有几种添加文件夹的手势

将文件夹添加到工作区

“文件”>“将文件夹添加到工作区”命令会弹出一个“打开文件夹”对话框，用于选择新文件夹。

添加根文件夹后，“资源管理器”将在文件资源管理器中将新文件夹显示为根目录。您可以右键单击任何根文件夹，并使用上下文菜单来添加或删除文件夹。

文件资源管理器应像以前一样工作和运行。您可以在根文件夹之间移动文件，并使用上下文菜单和资源管理器视图中提供的任何典型文件操作操作。

如果配置了，则每个根文件夹都支持诸如 files.exclude 之类的设置，如果配置为全局用户设置，则所有文件夹都支持。

拖放

您可以使用拖放操作将文件夹添加到工作区。将文件夹拖到文件资源管理器以将其添加到当前工作区。您甚至可以选择和拖动多个文件夹。

注意：将单个文件夹拖放到 VS Code 的编辑器区域仍然会以单文件夹模式打开该文件夹。如果您将多个文件夹拖放到编辑器区域，则将创建一个新的多根工作区。

您还可以使用拖放操作来重新排序工作区中的文件夹。

多选本机文件打开对话框

使用您的平台本机文件打开对话框打开多个文件夹将创建一个多根工作区。

命令行 --add

将一个或多个文件夹添加到多根工作区的最后一个活动的 VS Code 实例。

  code --add vscode vscode-docs

删除文件夹

您可以使用“从工作区中删除文件夹”上下文菜单命令从工作区中删除文件夹。

工作区文件

当您添加多个文件夹时，它们最初会放置在名为“未命名工作区”的工作区中，并且该名称将一直保留到您保存工作区为止。在您想要将其放在永久位置（例如，在您的桌面上）之前，您无需保存工作区。未命名工作区只要它们使用的 VS Code 实例处于打开状态就存在。一旦您完全关闭包含未命名工作区的实例，如果您计划将来再次打开它，系统将提示您保存它

当您保存工作区时，它将创建一个 .code-workspace 文件，并且文件名将显示在文件资源管理器中。

另存为工作区...

如果您想将工作区文件移动到新位置，可以使用“文件”>“另存为工作区”命令，该命令将自动设置相对于新工作区文件位置的正确文件夹路径。

打开工作区文件

要重新打开工作区，您可以

• 双击平台资源管理器中的 .code-workspace 文件。
• 使用“文件”>“打开工作区”命令并选择工作区文件。
• 从“文件”>“打开最近”列表中选择工作区 (⌃R (Windows, Linux Ctrl+R))。
  • 工作区具有 (工作区) 后缀，以将它们与文件夹区分开来。

就像在 VS Code 中打开单个文件夹时的“关闭文件夹”一样，有一个“关闭工作区” (⌘K F (Windows, Linux Ctrl+K F)) 命令来关闭活动工作区。

工作区文件架构

.code-workspace 的架构非常简单。您有一个文件夹数组，其中包含绝对路径或相对路径。当您想要共享工作区文件时，相对路径更好。

您可以使用 name 属性覆盖文件夹的显示名称，以便为资源管理器中的文件夹提供更有意义的名称。例如，您可以将项目文件夹命名为“Product”和“Documentation”，以便通过文件夹名称轻松识别内容

{
  "folders": [
    {
      // Source code
      "name": "Product",
      "path": "vscode"
    },
    {
      // Docs and release notes
      "name": "Documentation",
      "path": "vscode-docs"
    },
    {
      // Yeoman extension generator
      "name": "Extension generator",
      "path": "vscode-generator-code"
    }
  ]
}

这将导致以下资源管理器显示

从上面的示例中可以看出，您可以向工作区文件添加注释。

工作区文件还可以包含工作区全局设置（在 settings 下）和扩展建议（在 extensions 下），我们将在下面讨论。

通用 UI

编辑器

当您使用多根工作区时，VS Code UI 只有一些更改，主要是为了消除文件夹之间文件的歧义。例如，如果多个文件夹中的文件之间存在名称冲突，VS Code 将在选项卡标题中包含文件夹名称。

如果您始终希望在选项卡标题中显示文件夹，则可以使用 workbench.editor.labelFormat 设置 “medium”或“long”值来显示文件夹或完整路径。

"workbench.editor.labelFormat": "medium"

VS Code UI（例如“打开的编辑器”和“快速打开” (⌘P (Windows, Linux Ctrl+P)) 列表）包含文件夹名称。

如果您正在使用文件图标主题，并且活动主题支持它，您将看到一个特殊的工作区图标。

下面您可以看到来自内置 Minimal (Visual Studio Code) 文件图标主题的工作区图标

搜索

VS Code 功能（如全局搜索）可跨所有文件夹工作，并将搜索结果按文件夹分组。

当您打开多根工作区时，您可以选择在单个根文件夹中搜索，方法是在“包含的文件”框中使用 ./ 语法。例如，如果您输入 ./project1/**/*.txt，则将在 project1/ 根文件夹下搜索所有 .txt 文件。

设置

在一个工作区中有多个根文件夹的情况下，每个根文件夹中都可能有一个 .vscode 文件夹，用于定义应应用于该文件夹的设置。为避免设置冲突，使用多根工作区时，仅应用资源（文件、文件夹）设置。影响整个编辑器（例如，UI 布局）的设置将被忽略。例如，两个项目都不能设置缩放级别。

用户设置与单文件夹项目一样受支持，您还可以设置将应用于多根工作区中所有文件夹的全局工作区设置。全局工作区设置将存储在您的 .code-workspace 文件中。

{
  "folders": [
    {
      "path": "vscode"
    },
    {
      "path": "vscode-docs"
    },
    {
      "path": "vscode-generator-code"
    }
  ],
  "settings": {
    "window.zoomLevel": 1,
    "files.autoSave": "afterDelay"
  }
}

当您从单文件夹实例转到多文件夹时，VS Code 会将第一个文件夹中相应的编辑器范围设置添加到新的全局工作区设置中。

您可以轻松地通过“设置”编辑器查看和修改不同的设置文件。“设置”编辑器选项卡允许您选择“用户设置”、“全局工作区设置”和“单个文件夹设置”。

您还可以使用以下命令打开特定的设置文件

• 首选项：打开用户设置 - 打开您的全局用户设置
• 首选项：打开工作区设置 - 打开您的工作区文件的设置部分。
• 首选项：打开文件夹设置 - 打开活动文件夹的设置。

全局工作区设置将覆盖用户设置，文件夹设置可以覆盖工作区或用户设置。

不受支持的文件夹设置

不受支持的编辑器范围文件夹设置将在您的文件夹设置中显示为灰色，并且会从“默认文件夹设置”列表中过滤掉。您还将在设置前面看到一个信息图标。

调试

使用多根工作区，VS Code 会跨所有文件夹搜索 launch.json 调试配置文件，并将它们与文件夹名称作为后缀一起显示。此外，VS Code 还会显示在工作区配置文件中定义的启动配置。

上面的示例显示了 TSLint 扩展的调试配置。有一个来自 tslint 扩展文件夹的 launch 配置，用于启动在 VS Code 扩展主机中运行的扩展，还有一个来自 tslint-server 文件夹的 attach 配置，用于将调试器附加到正在运行的 TSLint 服务器。

您还可以看到 vscode-tslint 工作区中文件夹 tslint、tslint-server 和 tslint-tests 的三个“添加配置”命令。“添加配置”命令将打开文件夹的 .vscode 子文件夹中现有的 launch.json 文件，或者创建一个新文件并显示调试配置模板下拉列表。

配置中使用的变量（例如 ${workspaceFolder} 或现已弃用的 ${workspaceRoot}）相对于它们所属的文件夹解析。可以通过将根文件夹的名称附加到变量（用冒号分隔）来限定每个工作区文件夹的变量范围。

工作区启动配置

工作区范围的启动配置位于工作区配置文件的 "launch" 部分（命令面板中的“工作区：打开工作区配置文件”）

或者，可以通过“启动配置”下拉菜单的“添加配置（工作区）”条目添加新的启动配置

复合启动配置可以通过名称引用单个启动配置，只要名称在工作区内是唯一的，例如

  "compounds": [{
      "name": "Launch Server & Client",
      "configurations": [
        "Launch Server",
        "Launch Client"
      ]
  }]

如果单个启动配置名称不是唯一的，则可以使用更详细的“folder”语法指定限定文件夹

  "compounds": [{
      "name": "Launch Server & Client",
      "configurations": [
        "Launch Server",
        {
          "folder": "Web Client",
          "name": "Launch Client"
        },
        {
          "folder": "Desktop Client",
          "name": "Launch Client"
        }
      ]
  }]

除了 compounds 之外，工作区配置文件的 launch 部分也可以包含常规启动配置。确保所有使用的变量都显式限定到特定文件夹，否则它们对工作区无效。您可以在变量参考中找到有关显式限定范围的变量的更多详细信息。

这是一个启动配置的示例，其中程序位于文件夹“Program”中，并且当单步执行时应跳过文件夹“Library”中的所有文件

"launch": {
  "configurations": [{
      "type": "node",
      "request": "launch",
      "name": "Launch test",
      "program": "${workspaceFolder:Program}/test.js",
      "skipFiles": [
        "${workspaceFolder:Library}/out/**/*.js"
      ]
  }]
}

任务

与 VS Code 搜索调试配置的方式类似，VS Code 也会尝试自动检测来自工作区中所有文件夹的 gulp、grunt、npm 和 TypeScript 项目文件的任务，并搜索在 tasks.json 文件中定义的任务。任务的位置由文件夹名称后缀指示。请注意，在 tasks.json 中定义的任务必须是版本 2.0.0。

从上面的 TSLint 扩展 工作区 示例中，您可以看到来自 tslint 和 tslint-tests 文件夹中 tasks.json 文件的两个配置的任务，以及许多自动检测到的 npm 和 TypeScript 编译器检测到的任务。

工作区任务配置

工作区范围的任务位于工作区配置文件的 "tasks" 部分（命令面板中的“工作区：打开工作区配置文件”）。只有 "shell" 和 "process" 类型的任务可以在工作区配置文件中定义。

源代码管理

使用多根工作区时，有一个“源代码管理提供程序”部分，当您有多个活动存储库时，它可以为您提供概览。这些可以由多个 SCM 提供程序贡献；例如，您可以将 Git 存储库与 Azure DevOps Server 工作区并排放置。当您在此视图中选择存储库时，您可以在下面看到源代码管理详细信息。

您可以使用 Ctrl+单击 或 Shift+单击 来选择多个存储库。它们的详细信息将作为单独的区域显示在下方。

扩展

如果您是扩展作者，您可以查看我们的采用多根工作区 API 指南，以了解有关 VS Code 多根工作区 API 以及如何使您的扩展在多个文件夹中良好运行的信息。

以下是一些已采用多根工作区 API 的热门扩展。

注意：如果扩展尚不支持多个文件夹，它仍将在多根工作区的第一个文件夹中工作。

扩展建议

VS Code 通过文件夹的 .vscode 子文件夹下的 extensions.json 文件支持文件夹级别的扩展建议。您还可以通过将全局工作区扩展建议添加到您的 .code-workspace 文件来提供全局工作区扩展建议。您可以使用“扩展：配置建议的扩展（工作区文件夹）”命令打开您的工作区文件，并将扩展标识符 ({publisherName}.{extensionName}) 添加到 extensions.recommendations 数组。

{
  "folders": [
    {
      "path": "vscode"
    },
    {
      "path": "vscode-docs"
    }
  ],
  "extensions": {
    "recommendations": ["eg2.tslint", "dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
  }
}

后续步骤

• 什么是 VS Code “工作区”？ - 有关单文件夹和多根工作区的更多信息。
• 调试 - 了解如何为您的应用程序设置调试。
• 任务 - 任务允许您在 VS Code 中运行外部工具（如编译器）。

常见问题

如何返回到使用单个项目文件夹？

您可以关闭工作区并直接打开文件夹，或从工作区中删除文件夹。

作为扩展作者，我需要做什么？

请参阅我们的采用多根工作区 API 指南。大多数扩展都可以轻松支持多根工作区。