ESLint 中文文档

# no-unused-vars

禁止未使用的变量

配置文件中的 "extends": "eslint:recommended" 属性启用了该规则

由于重构不完整，已声明但未在代码中任何地方使用的变量很可能是错误。这样的变量会占用代码中的空间，并可能导致读者混淆。

# 规则详情

该规则旨在消除未使用的变量、函数和函数参数。

如果以下任何一项为真，则认为使用变量 foo：

  • 它被称为（foo()）或构造（new foo()）
  • 读取 (var bar = foo)
  • 它作为参数传递给函数（doSomething(foo)）
  • 它在传递给另一个函数（doSomething(function() { foo(); })）的函数内部读取

如果变量只被声明（var foo = 5）或分配给（foo = 7），则不认为它被使用。

此规则的错误代码示例：

/*eslint no-unused-vars: "error"*/
/*global some_unused_var*/

// It checks variables you have defined as global
some_unused_var = 42;

var x;

// Write-only variables are not considered as used.
var y = 10;
y = 5;

// A read for a modification of itself is not considered as used.
var z = 0;
z = z + 1;

// By default, unused arguments cause warnings.
(function(foo) {
    return 5;
})();

// Unused recursive functions also cause warnings.
function fact(n) {
    if (n < 2) return 1;
    return n * fact(n - 1);
}

// When a function definition destructures an array, unused entries from the array also cause warnings.
function getY([x, y]) {
    return y;
}

此规则的正确代码示例：

/*eslint no-unused-vars: "error"*/

var x = 10;
alert(x);

// foo is considered used here
myFunc(function foo() {
    // ...
}.bind(this));

(function(foo) {
    return foo;
})();

var myFunc;
myFunc = setTimeout(function() {
    // myFunc is considered used
    myFunc();
}, 50);

// Only the second argument from the destructured array is used.
function getY([, y]) {
    return y;
}

# exported

在 CommonJS 或 ECMAScript 模块之外的环境中，您可以使用 var 创建一个可供其他脚本使用的全局变量。您可以使用 /* exported variableName */ 注释块来指示该变量正在被导出，因此不应被视为未使用。

请注意，/* exported */ 对以下任何一项都没有影响：

  • 环境为 node 或 commonjs 时
  • 当 parserOptions.sourceType 是 module
  • 当 ecmaFeatures.globalReturn 是 true

行注释 // exported variableName 将不起作用，因为 exported 不是特定于行的。

/* exported variableName */ 操作的正确代码示例：

/* exported global_var */

var global_var = 42;

# 选项

此规则接受一个参数，该参数可以是字符串或对象。字符串设置与 vars 属性的设置相同（解释如下）。

默认情况下，此规则通过变量的 all 选项和参数的 after-used 选项启用。

{
    "rules": {
        "no-unused-vars": ["error", { "vars": "all", "args": "after-used", "ignoreRestSiblings": false }]
    }
}

# vars

vars 选项有两个设置：

  • all 检查所有变量的使用情况，包括全局范围内的变量。这是默认设置。
  • local 仅检查是否使用了本地声明的变量，但允许未使用全局变量。

# vars: local

{ "vars": "local" } 选项的正确代码示例：

/*eslint no-unused-vars: ["error", { "vars": "local" }]*/
/*global some_unused_var */

some_unused_var = 42;

# varsIgnorePattern

varsIgnorePattern 选项指定不检查用法的异常：名称与正则表达式模式匹配的变量。例如，名称包含 ignored 或 Ignored 的变量。

{ "varsIgnorePattern": "[iI]gnored" } 选项的正确代码示例：

/*eslint no-unused-vars: ["error", { "varsIgnorePattern": "[iI]gnored" }]*/

var firstVarIgnored = 1;
var secondVar = 2;
console.log(secondVar);

# args

args 选项具有三个设置：

  • after-used - 在最后使用的参数之前出现的未使用的位置参数将不被检查，但将检查所有命名参数和最后使用的参数之后的所有位置参数。
  • all - 必须使用所有命名参数。
  • none - 不检查参数。

# args: after-used

默认 { "args": "after-used" } 选项的错误代码示例：

/*eslint no-unused-vars: ["error", { "args": "after-used" }]*/

// 2 errors, for the parameters after the last used parameter (bar)
// "baz" is defined but never used
// "qux" is defined but never used
(function(foo, bar, baz, qux) {
    return bar;
})();

默认 { "args": "after-used" } 选项的正确代码示例：

/*eslint no-unused-vars: ["error", {"args": "after-used"}]*/

(function(foo, bar, baz, qux) {
    return qux;
})();

# args: all

{ "args": "all" } 选项的错误代码示例：

/*eslint no-unused-vars: ["error", { "args": "all" }]*/

// 2 errors
// "foo" is defined but never used
// "baz" is defined but never used
(function(foo, bar, baz) {
    return bar;
})();

# args: none

{ "args": "none" } 选项的正确代码示例：

/*eslint no-unused-vars: ["error", { "args": "none" }]*/

(function(foo, bar, baz) {
    return bar;
})();

# ignoreRestSiblings

ignoreRestSiblings 选项是一个布尔值（默认值：false）。使用 剩余属性 可以从对象中获得 "omit" 属性，但默认情况下，兄弟属性被标记为 "unused"。启用此选项后，其余属性的兄弟姐妹将被忽略。

{ "ignoreRestSiblings": true } 选项的正确代码示例：

/*eslint no-unused-vars: ["error", { "ignoreRestSiblings": true }]*/
// 'foo' and 'bar' were ignored because they have a rest property sibling.
var { foo, ...coords } = data;

var bar;
({ bar, ...coords } = data);

# argsIgnorePattern

argsIgnorePattern 选项指定不检查用法的异常：名称与正则表达式模式匹配的参数。例如，名称以下划线开头的变量。

{ "argsIgnorePattern": "^_" } 选项的正确代码示例：

/*eslint no-unused-vars: ["error", { "argsIgnorePattern": "^_" }]*/

function foo(x, _y) {
    return x + 1;
}
foo();

# destructuredArrayIgnorePattern

destructuredArrayIgnorePattern 选项指定不检查用法的异常：名称与正则表达式模式匹配的数组解构模式的元素。例如，名称以下划线开头的变量。

{ "destructuredArrayIgnorePattern": "^_" } 选项的正确代码示例：

/*eslint no-unused-vars: ["error", { "destructuredArrayIgnorePattern": "^_" }]*/

const [a, _b, c] = ["a", "b", "c"];
console.log(a+c);

const { x: [_a, foo] } = bar;
console.log(foo);

function baz([_c, x]) {
    x;
}
baz();

function test({p: [_q, r]}) {
    r;
}
test();

let _m, n;
foo.forEach(item => {
    [_m, n] = item;
    console.log(n);
});

let _o, p;
_o = 1;
[_o, p] = foo;
p;

# caughtErrors

caughtErrors 选项用于 catch 块参数验证。

它有两个设置：

  • none - 不检查错误对象。这是默认设置。
  • all - 必须使用所有命名参数。

# caughtErrors: none

不指定此规则相当于将其分配给 none。

{ "caughtErrors": "none" } 选项的正确代码示例：

/*eslint no-unused-vars: ["error", { "caughtErrors": "none" }]*/

try {
    //...
} catch (err) {
    console.error("errors");
}

# caughtErrors: all

{ "caughtErrors": "all" } 选项的错误代码示例：

/*eslint no-unused-vars: ["error", { "caughtErrors": "all" }]*/

// 1 error
// "err" is defined but never used
try {
    //...
} catch (err) {
    console.error("errors");
}

# caughtErrorsIgnorePattern

caughtErrorsIgnorePattern 选项指定不检查用法的异常：捕获名称与正则表达式模式匹配的参数。例如，名称以字符串 'ignore' 开头的变量。

{ "caughtErrorsIgnorePattern": "^ignore" } 选项的正确代码示例：

/*eslint no-unused-vars: ["error", { "caughtErrorsIgnorePattern": "^ignore" }]*/

try {
    //...
} catch (ignoreErr) {
    console.error("errors");
}

# 何时不使用

如果您不想收到有关未使用的变量或函数参数的通知，您可以安全地关闭此规则。

Last Updated: 5/13/2023, 8:55:38 PM

← no-use-before-define →