Versions

Developer Guide

本指南是为那些希望……的人准备的:

  • 为 ESLint 贡献代码
  • 创建自己的 ESLint 规则

为了以开发者的身份与ESLint一起工作,我们建议:

  • 你懂 JavaScript,因为 ESLint 是用 JavaScript 写的。
  • 你基本熟悉 Node.js,因为 ESLint 在它上面运行。
  • 你对命令行程序很熟悉。
  • 你了解单元测试以及它们如此重要的原因。

如果这听起来像你,那么继续阅读就可以开始了。

第一节:获取源代码

在你开始之前,你需要获得 ESLint 的代码。本节解释了如何做到这一点,以及关于源码结构的介绍。

第2节:设置开发环境

开发 ESLint 与在命令行上运行它有些不同。本节告诉你如何在准备好写代码前先设置好开发环境。

第三节:运行单元测试

ESLint 中包含了大量的单元测试,以确保代码质量够高。本节解释了如何运行单元测试。

第四节:使用规则

你终于准备好开始处理规则了。你可能想修正现有的规则或创建新的规则。本节解释了如何做到这一点。

第五节:使用插件

你已经为 ESLint 开发了特定库规则,你想与社区分享它们。你可以在 npm 上发布 ESLint 插件。

第六节:使用自定义解析器

如果你不打算使用 ESLint 的默认解析器,本节将解释如何使用自定义解析器。

第七节:Node.js API

如果你有兴趣编写一个使用 ESLint 的工具,那么你可以使用 Node.js API 来获得程序化功能。

第八节:贡献

如果你做了想与社区分享的改动,下一步就是通过 pull request 将这些改动提交回去。