ESLint 如何自定义规则？

Question

ESLint 如何自定义规则？

仓乃文 · Accepted Answer

ESLint 自定义规则通过编写规则函数实现，函数返回 meta（元信息）和 create（AST 遍历逻辑）。

自定义规则结构：
```javascript
// eslint-plugin-my-rules/lib/rules/no-console-in-production.js
module.exports = {
  meta: {
    type: "suggestion",  // problem | suggestion | layout
    docs: {
      description: "禁止在生产代码中使用 console",
      recommended: true,
    },
    fixable: null,  // 是否支持自动修复
    schema: [  // 配置项 schema
      {
        type: "object",
        properties: {
          allowMethods: {
            type: "array",
            items: { type: "string" },
          },
        },
      },
    ],
    messages: {
      noConsole: "不允许使用 console.{{method}}，请使用 logger 工具",
    },
  },

create(context) {
    const options = context.options[0] || {};
    const allowMethods = options.allowMethods || ["warn", "error"];

return {
      CallExpression(node) {
        if (
          node.callee.type === "MemberExpression" &&
          node.callee.object.name === "console" &&
          !allowMethods.includes(node.callee.property.name)
        ) {
          context.report({
            node,
            messageId: "noConsole",
            data: { method: node.callee.property.name },
          });
        }
      },
    };
  },
};
```

使用自定义规则：
```javascript
// .eslintrc.js
module.exports = {
  plugins: ["my-rules"],
  rules: {
    "my-rules/no-console-in-production": ["error", {
      allowMethods: ["warn", "error"],
    }],
  },
};
```

补充说明：
- create 返回的对象 key 是 AST 节点类型（如 CallExpression）
- context.report() 报告错误，context.getSourceCode() 获取源码
- 使用 astexplorer.net 可视化 AST 结构辅助开发
- 自定义规则可以发布为 npm 包供团队共享