← Back to rules

unicorn/catch-error-name 风格

An auto-fix is available for this rule.

它的作用

此规则强制要求在 catch 语句中对错误变量使用一致且具有描述性的命名，防止在使用错误时使用模糊的名称，如 badName 或 _。

为什么这是个问题？

使用像 badName 或 _ 这样不具描述性的名称会使代码更难阅读和理解，尤其是在调试时。使用清晰、一致的名称来表示错误非常重要。

示例

此规则的 错误 代码示例：

try {
} catch (badName) {}

// 如果 `_` 被使用，则不允许
try {
} catch (_) {
  console.log(_);
}

promise.catch((badName) => {});

promise.then(undefined, (badName) => {});

此规则的 正确 代码示例：

try {
} catch (error) {}

// 如果 `_` 没有被使用，则允许
try {
} catch (_) {
  console.log(123);
}

promise.catch((error) => {});

promise.then(undefined, (error) => {});

配置

此规则接受一个配置对象，包含以下属性：

ignore

type: string[]

检查 catch 变量名称时要忽略的模式列表。模式可以是字符串或正则表达式。

name

type: string

默认值: "error"

在 catch 块中用于错误变量的名称。您可以自定义为除 'error' 以外的其他名称（例如 'exception'）。

如何使用

要通过配置文件或在 CLI 中 启用 此规则，可以使用：

配置文件 (.oxlintrc.json)

{
  "rules": {
    "unicorn/catch-error-name": "error"
  }
}

CLI

oxlint --deny unicorn/catch-error-name

参考资料

• 规则源码