You need to enable JavaScript to run this app. 如何用ESLint禁止使用Error构造函数并引导使用MacroError?
优惠活动
大模型
产品
解决方案
定价
更多

如何用ESLint禁止使用Error构造函数并引导使用MacroError?

通过ESLint强制禁用new Error()、统一使用项目自定义错误类MacroError的实现方案

最省事的零依赖方案

根本不需要自己开发ESLint插件,用ESLint自带的no-restricted-syntax规则就能搞定。这个规则可以通过AST语法选择器精准匹配你想拦截的代码写法,命中后直接弹出你自定义的提示,配置完就能生效。

具体配置

根据你当前用的ESLint版本选对应的配置格式就行:

  • 传统.eslintrc配置(ESLint v8及更早版本常用):
{
  "rules": {
    "no-restricted-syntax": [
      "error",
      {
        // 同时覆盖带new和不带new的原生Error创建场景
        "selector": "NewExpression[callee.name='Error'], CallExpression[callee.name='Error']",
        "message": "禁止直接创建原生Error实例,请使用项目统一封装的 MacroError"
      }
    ]
  }
}
  • 扁平配置(ESLint v9+的默认配置格式):
// eslint.config.js
export default [
  {
    rules: {
      "no-restricted-syntax": [
        "error",
        {
          selector: "NewExpression[callee.name='Error'], CallExpression[callee.name='Error']",
          message: "禁止直接创建原生Error实例,请使用项目统一封装的 MacroError"
        }
      ]
    }
  }
]

踩坑提醒:不少人配置时只会匹配NewExpression节点,漏掉了不带new的调用场景——JS语法本身允许直接写throw Error('xxx')(省略new关键字时Error可以作为普通函数调用返回错误实例),如果不加CallExpression的匹配规则,这类违规写法完全漏检,一定要把两种语法都覆盖到。


特殊场景的豁免处理

规则默认会拦截所有位置的原生Error创建,记得给合理的特殊场景留好出口,不然容易误伤正常代码:

  • 自定义MacroError类的定义文件:因为这个类本身需要继承原生Error作为基类,这类场景不属于业务代码违规,可以在文件顶部加块级豁免注释,标注清楚原因方便维护:
// MacroError.js 自定义错误类定义文件的顶部
/* eslint-disable no-restricted-syntax -- 自定义错误类需继承原生Error基类 */
export class MacroError extends Error {
  // 自定义错误码、堆栈信息整理等业务逻辑
}
  • 极少数必须透传原生Error的兼容场景:比如对接老版第三方SDK时必须返回原生Error格式的场景,不需要全局放宽规则,直接在对应代码行上方加单行豁免就行,同样要写清楚豁免原因:
// eslint-disable-next-line no-restricted-syntax -- 对接旧版第三方SDK需透传原生错误格式
const legacyError = new Error('old sdk request failed')

可选的体验优化

如果想要进一步降低团队的改造成本,可以基于本地自定义ESLint规则实现自动修复能力——也就是在开发者保存代码时,ESLint可以自动把所有违规的new Error('xxx')替换为new MacroError('xxx')。这类规则不需要发布成公共npm包,直接把规则脚本放在项目目录下本地引入就行,核心匹配逻辑和上面写的选择器完全一致,只是在命中节点时给规则加一个自动替换的修复器即可。

内容的提问来源于stack exchange,提问作者GreeneCreations

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.29 19:54:05