设置开发环境

ESLint 拥有一个非常轻量级的开发环境，使代码更新快速且轻松。这是一个逐步指南，用于设置本地开发环境，以便您可以为项目做出贡献。

步骤 1：安装 Node.js

访问 https://node.org.cn/ 下载并安装适合您操作系统的最新稳定版本。

大多数安装程序都附带了 npm，但如果由于某种原因 npm 在您的系统上无法工作，您可以使用站点上的说明手动安装它。

访问 https://github.com/eslint/eslint 并点击“Fork”按钮。按照 GitHub 文档进行 Fork 和克隆操作。

克隆您的 Fork

git clone https://github.com/<Your GitHub Username>/eslint
1

克隆存储库后，运行 npm install 以获取所有必要的依赖项

cd eslint
npm install
1
2

此步骤需要连接到互联网才能正常工作。您将看到许多实用程序正在下载。

注意：每次从主存储库拉取时，重新运行 npm install 是一个好主意，以确保您拥有最新的开发依赖项。

上游源是进行活跃开发的主要 ESLint 存储库。虽然您将无法访问上游的推送权限，但您将拥有拉取权限，允许您在需要时随时拉取最新代码。

要添加 ESLint 的上游源，请在您的存储库中运行以下命令

git remote add upstream [email protected]:eslint/eslint.git
1

现在，远程 upstream 指向上游源。

Yeoman 是 ESLint 使用的脚手架生成器，有助于简化新规则的开发。如果您尚未安装 Yeoman，可以通过 npm 安装它

npm install -g yo
1

然后，您可以安装 ESLint Yeoman 生成器

npm install -g generator-eslint
1

请参阅生成器文档以获取有关如何使用它的说明。

运行测试是确保您已正确设置开发环境的最佳方法。确保您位于 eslint 目录中并运行

npm test
1

测试需要几分钟才能完成。如果任何测试失败，则可能表示环境设置的一个或多个部分未正确完成。上游测试始终通过。

ESLint 的目录和文件结构如下

bin - 安装 ESLint 时可用的可执行文件
conf - 默认配置信息
docs - 项目文档
lib - 包含源代码
- formatters - 所有定义格式化程序的源文件
- rules - 所有定义规则的源文件
tests - 主要单元测试文件夹
- lib - 源代码的测试
  - formatters - 格式化程序的测试
  - rules - 规则的测试

安装开发环境后，您可以对 ESLint 源文件进行更改并提交。成功执行此操作需要仔细遵守我们的拉取请求提交工作流程。

ESLint 有几个构建脚本，可以帮助开发的各个部分。

主要使用的脚本是 npm test，它执行以下操作

在进行更改并使用更改发送拉取请求之前，请务必运行此命令。

注意：完整的代码覆盖率报告输出到 /coverage 中。

仅对存储库运行 JavaScript 和 JSON 代码检查。

生成 build/eslint.js，这是在浏览器中使用的 ESLint 版本。

编辑此页面