设置开发环境

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

步骤 1：安装 Node.js

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

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

步骤 2：Fork 并检出您自己的 ESLint 仓库

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

克隆您的 fork

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

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

cd eslint
1

npm install
1

yarn add
1

pnpm add
1

bun add
1

您必须连接到互联网才能使此步骤生效。您将看到许多实用程序正在下载。

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

步骤 3：添加上游源

上游源是主要的 ESLint 仓库，活动开发在那里进行。虽然您没有上游的推送权限，但您将拥有拉取权限，允许您随时拉取最新的代码。

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

git remote add upstream git@github.com:eslint/eslint.git
1

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

步骤 4：安装 Yeoman 生成器

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

npm install --global yo
1

yarn global add yo
1

pnpm add --global yo
1

bun add --global yo
1

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

npm install --global generator-eslint
1

yarn global add generator-eslint
1

pnpm add --global generator-eslint
1

bun add --global generator-eslint
1

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

步骤 5：运行测试

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

npm test
1

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

参考信息

目录结构

ESLint 目录和文件结构如下

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

工作流程

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

构建脚本

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

npm test

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

1. Lint 所有 JavaScript（包括测试）和 JSON。
2. 在 Node.js 上运行所有测试。
3. 检查代码覆盖率目标。
4. 生成用于浏览器的 build/eslint.js。
5. 在 PhantomJS 中运行测试的子集。

确保在进行更改之后以及发送包含更改的 pull request 之前运行此命令。

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

npm run lint

仅对仓库运行 JavaScript 和 JSON lint。

npm run webpack

生成 build/eslint.js，一个用于浏览器的 ESLint 版本。