在 GitHub Codespaces 中设置 Node.js 项目

简介

本指南介绍如何使用 Visual Studio Code Web 客户端在 GitHub Codespaces 中设置示例 Node.js 项目。它将逐步引导您完成在 codespace 中打开项目以及添加和修改预定义开发容器配置的过程。

完成本教程后，您将能够使用 VS Code Web 客户端或 VS Code 桌面应用程序将开发容器配置添加到自己的存储库中。

有关开发容器的更多信息，请参阅“开发容器简介”。

步骤 1：在 Codespace 中打开项目

登录 GitHub.com，如果您还没有登录。
转到 https://github.com/microsoft/vscode-remote-try-node。
点击 **使用此模板**，然后点击 **在 Codespace 中打开**。

创建 Codespace 时，您的项目将在专用于您的远程虚拟机上创建。默认情况下，Codespace 的容器包含许多语言和运行时，包括 Node.js、JavaScript 和 TypeScript。它还包括一组常见的工具，例如 nvm、npm、yarn、git、wget、rsync、openssh 和 nano。

您可以通过调整 vCPU 和 RAM 的数量、添加点文件以个性化您的环境或修改已安装的工具和脚本来自定义您的 Codespace。有关更多信息，请参阅“自定义您的 Codespace”。

GitHub Codespaces 使用名为 devcontainer.json 的文件来配置您在 Codespace 中工作时使用的开发容器。每个存储库可以包含一个或多个 devcontainer.json 文件，以为您提供在 Codespace 中处理代码所需的开发环境。

启动时，GitHub Codespaces 使用 devcontainer.json 文件以及构成开发容器配置的任何依赖文件来安装工具和运行时，并执行项目所需的其它设置任务。有关更多信息，请参阅“开发容器简介”。

步骤 2：添加开发容器配置

GitHub Codespaces 的默认开发容器或“开发容器”将允许您成功地处理像 vscode-remote-try-node 这样的 Node.js 项目。但是，我们建议您配置自己的开发容器以包含项目所需的所有工具和脚本。这将确保您存储库中所有 GitHub Codespaces 用户的完全可复制的环境。

要将您的存储库设置为使用自定义开发容器，您需要创建一个或多个 devcontainer.json 文件。您可以从 Visual Studio Code 中的预定义配置模板添加这些文件，也可以自己编写。有关开发容器配置的更多信息，请参阅“开发容器简介”。

访问 Visual Studio Code 命令面板（Shift+Command+P / Ctrl+Shift+P），然后开始键入“add dev”。点击 **Codespaces：添加开发容器配置文件**。
点击 **创建新配置**。
在本例中，您从中创建 Codespace 的模板存储库已经包含开发容器配置，因此会显示一条消息，告诉您配置文件已存在。我们将覆盖现有的配置文件，因此请点击 **继续**。
点击 **显示所有定义**。
键入 node 并点击 **Node.js & JavaScript**。如果您的项目使用特定工具，则可以使用其他选项。例如，Node 和 MongoDB。
选择您要用于项目的 Node.js 版本。在本例中，选择标记为“(默认)”的版本。
将显示一个附加功能列表。我们将安装 JSHint，这是一个用于检测 JavaScript 代码中错误的代码质量工具。要安装此工具，请键入js，选择JSHint (via npm)，然后单击确定。
将显示一条消息，告知您开发容器配置文件已存在。单击覆盖。

将创建一个devcontainer.json文件，并在编辑器中打开。

自定义开发容器配置的详细信息

如果您查看 Visual Studio Code 资源管理器，您会看到一个.devcontainer目录已添加到项目存储库的根目录中，其中包含devcontainer.json文件。这是从该存储库创建的代码空间的主要配置文件。

devcontainer.json

您添加的devcontainer.json文件将包含name、image和features属性的值。一些您可能觉得有用的附加属性已包含在内，但已注释掉。

该文件将类似于此，具体取决于您选择哪个映像

// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/javascript-node
{
  "name": "Node.js",
  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
  "image": "mcr.microsoft.com/devcontainers/javascript-node:0-18-bullseye",
  "features": {
    "ghcr.io/devcontainers-contrib/features/jshint:2": {}
  }

  // Features to add to the dev container. More info: https://containers.dev/features.
  // "features": {},

  // Use 'forwardPorts' to make a list of ports inside the container available locally.
  // "forwardPorts": [],

  // Use 'postCreateCommand' to run commands after the container is created.
  // "postCreateCommand": "yarn install",

  // Configure tool-specific properties.
  // "customizations": {},

  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
  // "remoteUser": "root"
}

name：您可以将开发容器命名为任何您想要的名字。将提供默认值。
image：容器注册表中映像的名称（DockerHub、GitHub 容器注册表或Azure 容器注册表），它将用于为代码空间创建开发容器。
features：一个或多个对象的列表，每个对象都引用一个可用的开发容器功能。功能是自包含的、可共享的安装代码和开发容器配置单元。它们提供了一种简单的方法，可以将更多工具、运行时或库功能添加到您的开发容器中。您可以在 VS Code 中或在 GitHub.com 上的devcontainer.json编辑器中添加功能。有关更多信息，请单击“将功能添加到 devcontainer.json 文件”中的Visual Studio Code或Web 浏览器选项卡。
forwardPorts：此处列出的任何端口都将自动转发。有关更多信息，请参阅“在代码空间中转发端口”。
postCreateCommand: 使用此属性在您的代码空间创建后运行命令。它可以格式化为字符串（如上所示）、数组或对象。有关更多信息，请参阅开发容器网站上的开发容器规范。
customizations: 此属性允许您在使用特定工具或服务在代码空间中工作时对其进行自定义。例如，您可以为 VS Code 配置特定设置和扩展。有关更多信息，请参阅开发容器网站上的 "支持工具和服务"。
remoteUser: 默认情况下，您以 vscode 用户身份运行，但您可以选择将其设置为 root。有关可用属性的完整列表，请参阅开发容器网站上的开发容器规范。

如果您熟悉 Docker，除了 devcontainer.json 文件之外，您可能还想使用 Dockerfile 或 Docker Compose 来配置您的代码空间环境。您可以通过在 devcontainer.json 文件旁边添加您的 Dockerfile 或 docker-compose.yml 文件来实现。有关更多信息，请参阅开发容器网站上的 "使用镜像、Dockerfile 和 Docker Compose"。

步骤 3：修改您的 devcontainer.json 文件

添加您的开发容器配置并基本了解每个部分的功能后，您现在可以进行更改以进一步自定义您的环境。在本例中，您将添加以下属性：

在创建开发容器后运行 npm install，以安装 package.json 文件中列出的依赖项。
在此代码空间中自动安装 VS Code 扩展。

在 devcontainer.json 文件中，在 features 属性后添加逗号，并删除有关功能的两个注释行。

JSON

  "features": {
    "ghcr.io/devcontainers-contrib/features/jshint:2": {}
  },

  // Features to add to the dev container. More info: https://containers.dev/features.
  // "features": {},

  "features": {
    "ghcr.io/devcontainers-contrib/features/jshint:2": {}
  },

  // Features to add to the dev container. More info: https://containers.dev/features.
  // "features": {},

取消 postCreateCommand 属性的注释，并将其分配给命令 npm install。

JSONC

 // Use 'postCreateCommand' to run commands after the container is created.
 "postCreateCommand": "npm install",

 // Use 'postCreateCommand' to run commands after the container is created.
 "postCreateCommand": "npm install",

取消 customizations 属性的注释，并按如下方式对其进行编辑以安装 "Code Spell Checker" VS Code 扩展。

JSONC

// Configure tool-specific properties.
"customizations": {
  // Configure properties specific to VS Code.
  "vscode": {
    // Add the IDs of extensions you want installed when the container is created.
    "extensions": [
      "streetsidesoftware.code-spell-checker"
    ]
  }
}

// Configure tool-specific properties.
"customizations": {
  // Configure properties specific to VS Code.
  "vscode": {
    // Add the IDs of extensions you want installed when the container is created.
    "extensions": [
      "streetsidesoftware.code-spell-checker"
    ]
  }
}

根据您选择的镜像，devcontainer.json 文件现在应该看起来类似于以下内容

// README at: https://github.com/devcontainers/templates/tree/main/src/javascript-node
{
  "name": "Node.js",
  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
  "image": "mcr.microsoft.com/devcontainers/javascript-node:0-18-bullseye",
  "features": {
    "ghcr.io/devcontainers-contrib/features/jshint:2": {}
  },

  // Use 'forwardPorts' to make a list of ports inside the container available locally.
  // "forwardPorts": [],

  // Use 'postCreateCommand' to run commands after the container is created.
  "postCreateCommand": "npm install",

  // Configure tool-specific properties.
  "customizations": {
    // Configure properties specific to VS Code.
    "vscode": {
      // Add the IDs of extensions you want installed when the container is created.
      "extensions": [
        "streetsidesoftware.code-spell-checker"
      ]
    }
  }

  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
  // "remoteUser": "root"
}

保存您的更改。
访问 VS Code 命令面板（Shift+Command+P / Ctrl+Shift+P），然后开始输入 "rebuild"。点击 **Codespaces: 重建容器**。

提示： 您可能偶尔需要执行完整重建以清除缓存并使用新的镜像重建容器。有关更多信息，请参阅 "在 Codespace 中重建容器。"。

在您的 Codespace 中重建可以确保您的更改在您将更改提交到存储库之前按预期工作。如果出现故障，您将被放置在一个带有恢复容器的 Codespace 中，您可以从该容器中重建以继续调整您的容器。
在重建开发容器后，您的 Codespace 再次可用，postCreateCommand 将已运行，安装 npm，并且 "Code Spell Checker" 扩展将可用。