为什么我的自定义ESLint规则无法正确触发？

Code°紫瑶提问于 2026-02-19 18:36:25 阅读 44

工具

我在开发一个检查函数参数数量的ESLint插件，规则逻辑写好了但总不生效。比如写个加法函数：add(a, b)应该通过，但调用add(a)时规则没报错。

规则配置是这样的：


module.exports = {
    meta: { ... },
    create(context) {
        return {
            CallExpression(node) {
                if (node.callee.name === 'add' && node.arguments.length !== 2) {
                    context.report({
                        node,
                        message: 'add必须接收两个参数'
                    });
                }
            }
        };
    }
};

测试用例明明符合条件，控制台却没有任何输出。我尝试在回调函数里加console.log('test')调试，发现这个方法根本没被调用过。是不是访问者模式的节点类型写错了？或者需要额外配置什么选项？

ESLint Plugin开发

我来解答赞 6 收藏

反馈

2 条解答

郭云（打工版） Lv1

你这个规则本身逻辑没问题，但问题出在它只匹配了 add(a) 这种直接调用的情况，而实际项目里很可能用的是 import { add } from './math' 然后调用 add(a)，这时候 node.callee.name 是 add，但 node.callee.type 是 Identifier，不过更常见的是你插件没被 ESLint 加载进去，或者规则没注册。

先确认几件事：

1. 你的规则是不是放在了 rules 目录下，然后在 index.js 里正确导出了？比如：

module.exports.rules = {

  'add-arg-count': require('./rules/add-arg-count')

}

2. 你在 ESLint 配置里是不是写了插件名和规则名？比如 .eslintrc.js 里：

plugins: ['your-plugin-name'],

rules: {

  'your-plugin-name/add-arg-count': 'error'

}

3. 最容易踩的坑：你用的是 && 而不是 &&，这明显是复制粘贴时 HTML 实体转义没还原，直接导致语法错误或者逻辑错误。你贴出来的代码里是 &&，这在 JS 里是两个字符 & 和 amp;，不是逻辑与运算符。console.log('test') 没执行是因为条件根本没进得去。

修正后的代码应该是：

CallExpression(node) {

  if (node.callee.name === 'add' && node.arguments.length !== 2) {

    context.report({

      node,

      message: 'add必须接收两个参数'

    });

  }

}

如果还是不触发，可以加个 console.log(node.type) 看看有没有走到 CallExpression，一般 ESLint 能走到这一步，除非你规则根本没被加载。另外如果函数是通过对象调用的，比如 obj.add(a)，那 node.callee.name 就是 undefined 了，得用 node.callee.property.name。

通用的做法是用 node.callee.type === 'Identifier' && node.callee.name === 'add' 或者更稳妥地用 node.callee.type === 'MemberExpression' && node.callee.property.name === 'add' 来判断，或者用 node.callee.type === 'Identifier' || (node.callee.type === 'MemberExpression' && node.callee.property.name === 'add')。

如果还是不行，把你的完整插件目录结构贴出来看看，大概率是配置没对。

2026-02-24 23:06

闲人篷蔚 Lv1

问题出在你的访问者模式节点类型上，CallExpression 没问题，但你漏了配置规则的 meta.schema 和测试环境的规则启用部分。直接复制下面的代码：

module.exports = {

    meta: {

        type: 'problem',

        docs: {

            description: '强制 add 函数必须接收两个参数',

            category: 'Possible Errors',

            recommended: true

        },

        schema: [] // 确保这里有 schema 字段，即使为空

    },

    create(context) {

        return {

            CallExpression(node) {

                if (node.callee.type === 'Identifier' && node.callee.name === 'add') {

                    if (node.arguments.length !== 2) {

                        context.report({

                            node,

                            message: 'add 必须接收两个参数'

                        });

                    }

                }

            }

        };

    }

};

另外，检查下你的 ESLint 配置文件，确保规则已经正确加载和启用。比如：

module.exports = {

    parserOptions: {

        ecmaVersion: 2020

    },

    rules: {

        'your-rule-name': 'error' // 替换为你的规则名

    }

};

最后提醒一下，调试的时候不要只靠 console.log，可以在 create 方法里加个断点，确保规则注册进去了。我之前也踩过类似的坑，折腾半天发现是规则没启用来着。

2026-02-19 19:01