no-unused-vars

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

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

规则细节

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

如果以下任一情况属实，则认为使用变量：

它代表一个被称为（doSomething()）的函数，

它被读取（var y = x）

它作为参数传递给一个函数（doSomething(x)）

它是在传递给另一个函数（doSomething(function() { foo(); })）的函数内读取的，

如果一个变量只被赋值给（）或声明，那么该变量不被视为使用var x = 5。

此规则的错误代码示例：

/*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 descructured 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 - 只有最后一个参数必须使用。例如，这允许您为函数使用两个命名参数，并且只要您使用第二个参数，ESLint 就不会警告您第一个参数。这是默认设置。

all - 必须使用所有命名的参数。

none - 不检查参数。

args: after-used

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

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

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

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

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

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

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。使用Rest属性可以从对象中“省略”属性，但默认情况下，兄弟属性被标记为“未使用”。启用此选项后，其他属性的兄弟会被忽略。

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

/*eslint no-unused-vars: ["error", { "ignoreRestSiblings": true }]*/
// 'type' is ignored because it has a rest property sibling.
var { type, ...coords } = data;

argsIgnorePattern

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

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

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

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

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");
}

何时不使用它

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

版本

该规则在 ESLint 0.0.9中引入。

资源

Rule source

Documentation source

本文档系腾讯云开发者社区成员共同维护，如有问题请联系 cloudcommunity@tencent.com

最后更新于：2017-12-18