Gutenberg 区块编辑器文档

title: "Node.js 开发环境" post_status: publish comment_status: open taxonomy: category: - gutenberg-docs post_tag: - Devenv - Getting Started - Repos


Node.js 开发环境

为区块编辑器进行开发时,你将需要 Node.js 开发工具,以及一个代码编辑器和本地 WordPress 环境(参见区块开发环境)。Node.js (node) 是一个开源运行时环境,允许你从终端(也称为命令行界面、CLI 或 shell)执行 JavaScript 代码。

安装 node 将自动包含 Node 包管理器 (npm) 和 Node 包执行器 (npx),这是你在区块和插件开发中经常使用的两个工具。

Node 包管理器 (npm) 用途多样,包括依赖管理和脚本执行。它是推荐的包管理器,并在所有文档中被广泛提及。

Node 包执行器 (npx) 工具用于运行来自包的命令而无需全局安装,通常在通过 create-block 包搭建区块时使用。

在 Mac 和 Linux 上安装 Node.js(使用 nvm

建议使用 Node Version Manager (nvm) 来安装 Node.js。这允许你安装和管理特定版本的 node,这些版本会安装在你的主目录中,从而避免任何全局权限问题。

以下是使用 nvm 安装 node 并为区块开发设置推荐 Node.js 版本的快速指南。更多详情请参阅完整安装指南

  1. 打开终端并运行以下命令来安装 nvm。在 macOS 上,默认不安装所需的开发者工具。如果提示,请安装它们。
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
  1. 退出并重新启动终端。
  2. 在终端中运行 nvm install --lts 以安装最新的 LTS(长期支持)版本的 Node.js。
  3. 在终端中运行 node -vnpm -v 以验证已安装的 nodenpm 版本。

如果需要,你也可以安装特定版本的 node。例如,运行 nvm install 18 安装版本 18,并通过运行 nvm use [版本号] 在不同版本之间切换。更多详情请参阅 nvm使用指南

一些项目,如 Gutenberg,包含一个 .nvmrc 文件,该文件指定了应使用的 node 版本。在这种情况下,运行 nvm use 将自动选择正确的版本。如果该版本尚未安装,你将收到一个错误,提示需要添加哪个版本。运行 nvm install [版本号],然后运行 nvm use

在 Windows 及其他系统上安装 Node.js

你可以直接从 Node.js 官网下载安装程序。建议安装最新版本。提供适用于 Windows 和 Mac 的安装程序,以及适用于 Linux 的二进制文件。

微软也提供了关于如何在 Windows 和 WSL 上安装 nvm 和 Node.js 的详细指南

故障排除

如果在尝试安装 node 时遇到错误 zsh: command not found: nvm,您可能需要创建默认的配置文件。

在 macOS 上,默认的 shell 是 zsh,因此请在终端中运行 touch ~/.zshrc 来创建配置文件。如果文件已存在,运行此命令也无妨。对于 Ubuntu(包括 WSL),默认的配置文件是 bash,因此请改用 touch ~/.bashrc。然后重复步骤 2-4。

最新的 node 版本应适用于大多数开发项目,但请注意,某些软件包和工具有特定的要求。如果遇到问题,您可能需要安装并使用较早的 node 版本。同时,请务必检查项目是否有 .nvmrc 文件,并使用其中指定的 node 版本。

Additional resources