Selecting a version will take you to the chosen version of the ESLint docs.

在项目中使用 ESLint

本指南针对想要直接使用 ESLint 用户。如果你正在寻找扩展 ESLint 或使用 ESLint 源码的方式,请查看扩展 ESLint 文档

入门

想要跳过前期准备直接开始使用 ESLint?本章节对安装、设置和配置项进行了高水平概述。

核心概念

理解 ESLint 中的主要组件并指导如何在自己对项目中使用它们。

配置 ESLint

当 ESLint 成功运行后,你可能会想要调整配置以更好地适应你的项目。本章节一一解释了所有不同的 ESLint 配置方式。

命令行参考

ESLint 命令行有许多标志,本章节对它们的作用进行了解释。

规则参考

ESLint 有许多可以根据项目需求进行配置并微调的规则。此章节详细列出了所有规则并附上每一规则文档的链接。

格式化工具参考

使用格式化工具控制检查结果的外观,可以在此页中看到所有内置的格式化工具。

集成

想知道自己所喜欢的编辑器或构建系统能否与 ESLint 一同使用?此页列出了一些集成(由其作者提交)。

规则废弃

ESLint 团队致力于使升级过程尽可能无痛且容易。本章节概述了团队针对在未来版本中废止规则所制定的方针。

迁移

如果你正在使用旧版 ESLint,可以阅读以下内容获取迁移帮助:

主题切换

切换到你所选择语言版本对应的 ESLint 网站。