website

ESLint Docs

所属分类:开发者在线工具箱

ESLint:JavaScript 代码检查工具的配置与插件文档

ESLint 是可插拔的 JavaScript 代码检查工具,官方文档站按使用者、扩展开发者、集成开发者和贡献者分组。文档提供 HEAD、v10、v9、v8 等多个版本,语言选择器中也有简体中文版本。

ESLint:配置 JavaScript 检查规则、编写插件并查阅各版本文档

发布于 2026年10月18日更新于 2026年10月29日

首页按读者分组

首页的 Documentation 把内容分为五类:Use ESLint in Your Project 面向使用者,收录核心规则、配置、命令行、格式化器、集成和迁移指南;Extend ESLint 面向需要编写规则、配置、插件或格式化器的人;Integrate ESLint 介绍如何通过 Node.js API 集成;Contribute to ESLint 与 Maintain ESLint 分别面向贡献者和维护者。

左侧的版本选择器列出 HEAD、v10.13.0、v9.39.5 与 v8.57.1,并有 Previous Versions 入口。语言选择器中包括 English (US) 与 简体中文。

ESLint 文档首页截图:左侧为版本选择器,显示 v10.13.0,正文列出 Use ESLint in Your Project、Extend ESLint、Integrate ESLint 与 Contribute to ESLint 等分组

入门说明与配置目录

Getting Started 页面说明,ESLint 用于识别并报告 ECMAScript/JavaScript 代码中的模式,目标是让代码更一致并减少错误。运行前需要 Node.js ^20.19.0、^22.13.0 或 24 及以上版本。页面给出的步骤是运行 npm init @eslint/config@latest,按提示回答问题,生成 eslint.config.js 或 eslint.config.mjs 配置文件。从 9.0.0 之前的版本迁移时,页面建议先阅读迁移指南。

目录中的 Configure ESLint 下还有 Configuration Files、Configure Rules、Configure Plugins、Configure a Parser、Combine Configs、Ignore Files 和 Debug Your Configuration 等页面。Command Line Interface Reference、Rules Reference 与 Formatters Reference 则分别对应命令行、规则和格式化器的参考资料。

排查 v9 规则 API 报错

排错页的标题为 TypeError: context.getScope is not a function。页面说明,ESLint v9.0.0 或更高版本与插件一起使用时,可能看到 context.getScope、context.getAncestors、context.markVariableAsUsed 或 context.getDeclaredVariables 不是函数的错误。原因是 v9.0.0 修改了规则 API,把部分方法从 context 对象移到了 sourceCode 对象上,仍使用旧写法的插件就会报错。

ESLint 排错页截图:标题为 TypeError: context.getScope is not a function,Symptoms 小节下列出四条相似的报错代码

页面给出的处理办法包括两种:把插件升级到最新版本,或在配置文件中使用兼容工具为插件打补丁。页面还提醒,如果已经使用最新版插件仍需要兼容工具,应在插件仓库中向维护者提交 issue。