ESLint - JavaScript 代码检查工具
文章目录
- 一、关于 ESLint
- 1、项目概览
- 2、相关链接资源
- 二、安装配置
- 1、基础安装
- 2、pnpm 支持
- 三、核心功能
- 1、规则配置
- 四、常见问题
- 1、JSX 支持
- 2、与 Prettier 区别
- 3、ECMAScript 支持
- 五、版本策略
- 六、安全与规范
一、关于 ESLint
1、项目概览
ESLint 是一个用于识别和报告 ECMAScript/JavaScript 代码模式的工具。与 JSLint 和 JSHint 类似,但具有以下特点:
- 使用 Espree 进行 JavaScript 解析
- 通过 AST 评估代码模式
- 完全可插拔架构,每条规则都是插件且支持运行时添加
2、相关链接资源
- Github:https://github.com/eslint/eslint
- 官网:https://eslint.org
- 官方文档:
- 配置指南:https://eslint.org/docs/latest/use/configure
- 规则列表:https://eslint.org/docs/rules/
- 社区支持:
- Discord:https://eslint.org/chat
- Twitter:https://twitter.com/geteslint
- Mastodon:https://fosstodon.org/@eslint
- Bluesky:https://bsky.app/profile/eslint.org
- 赞助:https://eslint.org/donate
- License:MIT License
Badge 资源:
- npm 版本:https://www.npmjs.com/package/eslint
- 下载量:https://www.npmjs.com/package/eslint
- CI 状态:https://github.com/eslint/eslint/actions
- Open Collective 支持者:https://opencollective.com/eslint
二、安装配置
1、基础安装
前置要求:Node.js (^18.18.0
, ^20.9.0
或 >=21.1.0
) 且支持 SSL
安装命令:
npm init @eslint/config@latest
使用示例:
npx eslint yourfile.js
2、pnpm 支持
建议在 .npmrc
中添加:
auto-install-peers=true
node-linker=hoisted
三、核心功能
1、规则配置
示例配置 (eslint.config.js
):
import { defineConfig } from "eslint/config";export default defineConfig([{files: ["**/*.js"],rules: {"prefer-const": "warn","no-constant-binary-expression": "error"}}
]);
规则级别:
"off"
/0
- 禁用规则"warn"
/1
- 警告级别"error"
/2
- 错误级别
四、常见问题
1、JSX 支持
原生支持 JSX 语法解析(需配置),但对 React 语义需配合 eslint-plugin-react
2、与 Prettier 区别
ESLint 是代码检查工具,Prettier 是格式化工具,二者可配合使用
3、ECMAScript 支持
完整支持 ECMAScript 3/5 及 2015 后的所有 stage 4 标准
五、版本策略
- 采用语义化版本控制
- 提供当前版本完整支持和上一版本 6 个月的有限支持
- 商业支持通过 [Tidelift][tidelift] 和 [HeroDevs][herodevs] 提供
六、安全与规范
- 安全政策:https://github.com/eslint/.github/blob/master/SECURITY.md
- 行为准则:https://eslint.org/conduct
伊织 xAI 2025-09-23(二)