Skip to main content
我们经常发布文档更新,此页面的翻译可能仍在进行中。 有关最新信息,请访问英语文档

在存储库的 codespace 中自动打开文件

当用户为你的存储库创建 codespace 并在 Visual Studio Code Web 客户端中打开 codespace 时,你可以设置自动打开特定文件。

谁可以使用此功能

People with write permissions to a repository can create or edit the codespace configuration.

概述

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

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

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

设置要自动打开的文件

  1. 可以通过向 devcontainer.json 文件添加设置来配置为存储库创建的 codespace。 如果存储库尚未包含 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. 保存文件并将更改提交到存储库的所需分支。

延伸阅读