定制ESLint规则可解决团队特殊需求，如禁用console.log、强制命名规范等。通过创建插件，编写基于AST的规则逻辑，在create中匹配节点并报告问题，最后在.eslintrc.js中引入规则。利用AST Explorer、添加测试、支持配置和修复建议可提升规则质量。掌握后能固化最佳实践，减少低级错误。
在团队协作开发中，统一的代码风格和规范能显著提升代码可读性和维护效率。JavaScript作为一门灵活但容易写出“脏代码”的语言，尤其需要借助工具进行约束。ESLint 是目前最主流的 JavaScript 代码检查工具，它不仅支持大量内置规则，还允许开发者根据项目需求定制规则，实现高度个性化的代码规范管理。
为什么需要定制 ESLint 规则？
虽然 ESLint 提供了数百条默认规则，比如 no-unused-vars、semi、quotes 等，但在实际项目中，团队可能会有以下特殊需求：
- 限制某些 API 的使用（如禁止使用 console.log）
- 强制使用特定命名规范（如 React 组件必须大写开头）
- 校验自定义函数调用方式（如必须传入回调）
- 适配私有框架或内部库的编码约定
这些场景下，通用规则无法满足要求，就需要开发自定义规则。
如何开发自定义 ESLint 规则？
ESLint 支持通过插件机制扩展规则。自定义规则本质上是一个函数，接收 AST（抽象语法树）节点，在遍历过程中判断是否符合预期模式。
立即学习“Java免费学习笔记（深入）”；
步骤一：创建插件结构
新建一个 npm 包，目录结构如下：
my-eslint-plugin/ ├── lib/ │ ├── rules/ │ │ └── no-console-log.js │ └── index.js ├── package.json
步骤二：编写规则逻辑
以禁止使用 console.log 为例：
功能介绍：1.程序独立使用的MVC模式开发，程序代码与模板分离，会HTML就会做程序模板2.使用sqlite数据库，mysql数据库随便换，让您不再为购买数据库而烦恼3.增加首页数据自定义功能，导航数据自定义，快速打造属于您自己的网站4.seo伪静态设置更智能化，自定义seo规则，让蜘蛛更喜欢您的网站5.屏蔽ip访问功能5.支持一键采集功能，只要轻轻一点，上万淘宝b2c商品轻松入库，解决数据添加的
// lib/rules/no-console-log.js
module.exports = {
meta: {
type: 'suggestion',
docs: {
description: 'Disallow the use of console.log',
},
schema: [], // 规则不接受配置参数
messages: {
unexpectedConsoleLog: 'Unexpected console.log detected.'
}
},
create(context) {
return {
MemberExpression(node) {
if (
node.object.type === 'Identifier' &&
node.object.name === 'console' &&
node.property.type === 'Identifier' &&
node.property.name === 'log'
) {
context.report({
node,
messageId: 'unexpectedConsoleLog'
});
}
}
};
}
};
步骤三：导出插件
在 index.js 中注册规则：
// lib/index.js
module.exports = {
rules: {
'no-console-log': require('./rules/no-console-log')
}
};
步骤四：使用插件
安装插件后，在项目根目录的 .eslintrc.js 中引用：
module.exports = {
plugins: ['my-eslint-plugin'],
rules: {
'my-eslint-plugin/no-console-log': 'error'
}
};
高级技巧与注意事项
开发自定义规则时，有几个关键点需要注意：
- 利用 AST Explorer 工具查看代码对应的 AST 结构，便于精准匹配节点
- 合理使用 context.report() 提供修复建议（fixer）
- 为规则添加单元测试（可用 eslint-rule-tester）
- 支持可配置性，通过 meta.schema 定义选项
- 避免性能问题，不要在遍历中做复杂计算或重复创建对象
例如，让规则支持忽略生产环境的 log：
meta: {
schema: [
{
type: 'object',
properties: {
allowInProduction: { type: 'boolean' }
}
}
]
},
create(context) {
const options = context.options[0] || {};
const { allowInProduction } = options;
// 可结合注释或环境变量判断是否放行
}
基本上就这些。自定义 ESLint 规则看似门槛高，实则逻辑清晰：分析 AST → 匹配模式 → 报告问题。一旦掌握，就能把团队的最佳实践固化成自动检查，极大减少 code review 中的低级争议。不复杂但容易忽略。
