在 GitHub Codespaces 中设置 Node.js 项目

简介

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

完成本教程后，您将能够使用 VS Code 网页客户端或 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 的默认开发容器（或“开发容器”）允许您成功处理 Node.js 项目，例如 vscode-remote-try-node。但是，我们建议您配置您自己的开发容器以包含项目所需的所有工具和脚本。这将确保您仓库中所有 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 文件。这是从此仓库创建的 Codespace 的主要配置文件。

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

如果您熟悉 Docker，除了 devcontainer.json 文件外，您可能还希望使用 Dockerfile 或 Docker Compose 来配置您的 Codespace 环境。您可以通过将您的 Dockerfile 或 docker-compose.yml 文件与 devcontainer.json 文件一起添加来实现此目的。有关更多信息，请参阅开发容器网站上的使用镜像、Dockerfile 和 Docker Compose。

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

添加开发容器配置并了解其所有功能后，您现在可以进行更改以进一步自定义您的环境。在此示例中，您将添加将执行以下操作的属性：

创建开发容器后，运行 npm install 以安装 package.json 文件中列出的依赖项。
在此 Codespace 中自动安装 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 属性的注释，并按如下所示对其进行编辑以安装“代码拼写检查器”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，“代码拼写检查器”扩展将可用。