多根工作区

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

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

添加文件夹

向现有工作区添加另一个文件夹很简单。有几种添加文件夹的方式

添加文件夹到工作区

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

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

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

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

拖放

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

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

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

多选原生文件打开对话框

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

命令行 --add

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

  code --add vscode vscode-docs

移除文件夹

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

工作区文件

当您添加多个文件夹时，它们最初会被放置在一个名为UNTITLED WORKSPACE（无标题工作区）的工作区中，该名称将一直保留，直到您保存工作区。您无需保存工作区，除非您想将其保存在一个永久位置，例如桌面上。只要使用这些无标题工作区的 VS Code 实例保持打开，这些工作区就存在。一旦您完全关闭带有无标题工作区的实例，如果您计划将来再次打开它，系统将提示您保存。

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

工作区另存为...

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

打开工作区文件

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

• 在您的平台文件资源管理器中双击 .code-workspace 文件。
• 使用文件 > 打开工作区 命令并选择工作区文件。
• 从文件 > 最近打开 (⌃R (Windows, Linux Ctrl+R)) 列表中选择工作区。
  • 工作区带有(工作区)后缀，以区别于文件夹。

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

工作区文件模式

.code-workspace 的模式相当直观。它包含一个文件夹数组，使用绝对路径或相对路径。当您想共享工作区文件时，相对路径更好。

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

{
  "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 下的 扩展推荐，我们将在下面讨论。

通用用户界面

编辑器

使用多根工作区时，VS Code 用户界面只有几处更改，主要用于区分不同文件夹中的文件。例如，如果多个文件夹中的文件存在名称冲突，VS Code 将在标签页标题中包含文件夹名称。

如果您总是希望在标签页标题中显示文件夹，可以使用 workbench.editor.labelFormat 设置的“medium”或“long”值来显示文件夹或完整路径。

"workbench.editor.labelFormat": "medium"

VS Code 用户界面，例如打开的编辑器和快速打开 (⌘P (Windows, Linux Ctrl+P)) 列表，都包含文件夹名称。

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

您可以在下方看到内置的最小 (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+Click 或 Shift+Click 选择多个仓库。它们的详细信息将显示在下方，每个仓库一个区域。

扩展

如果您是扩展作者，可以查阅我们的采用多根工作区 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 指南。大多数扩展可以轻松支持多根工作区。