跳至主要内容

在代码空间中自动打开存储库中的文件

您可以设置特定文件,以便在有人为您的存储库创建代码空间并在 Visual Studio Code Web 客户端中打开代码空间时自动打开。

谁可以使用此功能?

具有存储库写入权限的人员可以创建或编辑代码空间配置。

概述

如果有一个特定文件对人们在为您的存储库创建代码空间时查看很有用,您可以将此文件设置为在 VS Code Web 客户端中自动打开。您可以在存储库的开发容器配置文件中进行设置。

您指定的文件仅在首次在 Web 客户端中打开代码空间时打开。如果用户关闭了指定的文件,则下次用户打开或重新启动代码空间时,这些文件不会自动重新打开。

注意

此自动化仅适用于 VS Code Web 客户端,不适用于 VS Code 桌面应用程序或其他受支持的编辑器。

设置要自动打开的文件

  1. 您可以通过向 devcontainer.json 文件添加设置来配置为您的存储库创建的代码空间。如果您的存储库尚不包含 devcontainer.json 文件,则可以立即添加一个。请参阅“向您的存储库添加开发容器配置”。

  2. 编辑 devcontainer.json 文件,添加 customizations.codespaces.openFiles 属性。customizations 属性位于文件的顶层,位于封闭的 JSON 对象内。例如

    JSON
    "customizations": {
      "codespaces": {
        "openFiles": [
          "README.md",
          "scripts/tsconfig.json",
          "docs/main/CODING_STANDARDS.md"
        ]
      }
    }
    

    openFiles 属性的值是一个或多个存储库中文件的数组。路径相对于存储库的根目录(不支持绝对路径)。文件将按照指定的顺序在 Web 客户端中打开,数组中的第一个文件将在编辑器中显示。

  3. 保存文件并将更改提交到存储库的所需分支。

进一步阅读