Skip to main content

向 devcontainer.json 文件添加功能

借助这些功能,可以快速将工具、运行时或库添加到开发容器配置。

功能是指安装代码和开发容器配置的独立单元,其设计目的是跨各种基本容器映像工作。 可以使用功能将工具、运行时或库快速添加到 codespace 映像。 有关详细信息,请参阅“开发容器”网站上的可用功能功能规范

可以从 VS Code 或 上的存储库向 devcontainer.json 文件添加功能。 使用本文中的选项卡可显示上述每一种功能的添加方式的说明。

devcontainer.json 文件添加功能

  1. 导航到 上的存储库,找到 devcontainer.json 文件,然后单击“”编辑文件。

    如果还没有 devcontainer.json 文件,可以立即创建一个。 有关详细信息,请参阅“开发容器简介”。

  2. 在文件编辑器右侧的“市场”选项卡中,浏览或搜索要添加的功能,然后单击功能的名称。

    “市场”选项卡的屏幕截图,搜索框中包含“Terra”,搜索结果中列出了 Terraform 功能。

  3. 在“安装”下,单击代码片段将其复制到剪贴板,然后将代码片段粘贴到 devcontainer.json 文件中的 features 对象中。

    “市场”选项卡的屏幕截图,其中显示了 Terraform 的安装代码片段。

    "features": {
         // ...
         "ghcr.io/devcontainers/features/terraform:1": {},
         // ...
     }
    
  4. 默认情况下,将使用最新版本的功能。 若要选择其他版本或为功能配置其他选项,请展开“选项”下列出的属性查看可用值,然后通过手动编辑 devcontainer.json 文件中的对象添加选项。

    “市场”选项卡“选项”部分的屏幕截图,其中展开了“版本”和“tflint”属性。

    "features": {
         // ...
         "ghcr.io/devcontainers/features/terraform:1": {
             "version": "1.1",
             "tflint": "latest"
         },
         // ...
     }
    
  5. 将更改提交到 devcontainer.json 文件。

配置更改将在从存储库创建的新 codespace 中生效。 若要使更改在现有 codespace 中生效,需要将 devcontainer.json 文件的更新拉入 codespace,然后重新生成 codespace 的容器。 有关详细信息,请参阅“开发容器简介”。

注意

若要在本地工作且未连接到 codespace 时在 VS Code 中添加功能,必须安装并启用“开发容器”扩展。 有关该扩展的详细信息,请参阅 VS Code Marketplace

  1. 使用 Shift+Command+P (Mac) 或 Ctrl+Shift+P (Windows/Linux) 访问 VS Code Command Palette。

  2. 开始键入“add dev”,然后单击“Codespaces: 添加开发容器配置文件”。

    命令面板的屏幕截图,其中输入了“add dev”,并列出了“Codespaces: 添加开发容器配置文件”。

  3. 单击“修改活动配置”。

  4. 更新功能选择,然后单击“确定”。

  5. 如果在 codespace 中操作,右下角将显示一条提示。 若要重新生成容器并将更改应用于你正在使用的 codespace,请单击“立即重新生成”。

    以下消息的屏幕截图:“我们已注意到开发容器配置发生了更改。” 下面是“立即重新生成”按钮。