User Guide

This guide is intended for those who wish to use ESLint as an end-user. If you’re looking for how to extend ESLint or work with the ESLint source code, please see the Developer Guide.

这个指导是为了那些希望使用 ESLint 的终端用户。如果你正在寻找如何扩展 ESLint 或者如何使用 ESLint 的源码,请看开发者指南

Getting Started

Want to skip ahead and just start using ESLint? This section gives a high-level overview of installation, setup, and configuration options.

想要跳过开头并且直接使用 ESLint ?本章节将给你一个高级别的安装,配置选项的概括。


ESLint has a lot of rules that you can configure to fine-tune it to your project. This section is an exhaustive list of every rule and link to each rule’s documentation.

ESLint 有很多规则以便你可以配置调整你的项目,本章节详细的列举了每个规则并且链接到每个规则的文档。


Once you’ve got ESLint running, you’ll probably want to adjust the configuration to better suit your project. This section explains all the different ways you can configure ESLint.

一旦你的 ESLint 运行起来后,你可能想要调整配置是你的项目更加合适。本章节将讲解所有可以配置 ESLint 不同的方式

Command Line Interface

There are a lot of command line flags for ESLint and this section explains what they do.

ESLint 有很多命令行标识,本章节将介绍它们都是干什么的。


Wondering if ESLint will work with your favorite editor or build system? This section has a list of all known integrations (submitted by their authors).

不知 ESLint 是否能够兼容你最爱的编辑器或构建系统,本章节列举了所有已知的集成方法(系作者提交)。

Rule Deprecation

The ESLint team is committed to making upgrading as easy and painless as possible. This section outlines the guidelines the team has set in place for the deprecation of rules in future releases.

ESLint 团队致力于尽可能精简的无痛升级。本章节概述了该团队设置的在未来版本要弃用的规则的指南。


If you were using a prior version of ESLint, you can get help with the transition by reading:

如果你在是用 ESLint 之前的版本,你可以通过阅读以下内容来获得版本过渡的帮助: