id-length

强制执行最小和最大标识符长度

很短的标识符名称（如 e、x、_t）或很长的标识符名称（如 hashGeneratorResultOutputContainerObject）会使代码更难阅读并且可能更难维护。为了防止这种情况，可以强制执行最小和/或最大标识符长度。

¥Very short identifier names like e, x, _t or very long ones like hashGeneratorResultOutputContainerObject can make code harder to read and potentially less maintainable. To prevent this, one may enforce a minimum and/or maximum identifier length.

var x = 5; // too short; difficult to understand its purpose without context

规则详情

¥Rule Details

此规则强制执行最小和/或最大标识符长度约定。

¥This rule enforces a minimum and/or maximum identifier length convention.

此规则计算 graphemes 而不是使用 String length。

¥This rule counts graphemes instead of using String length.

选项

¥Options

使用默认选项的此规则的错误代码示例：

¥Examples of incorrect code for this rule with the default options:

在线运行 
/*eslint id-length: "error"*/     // default is minimum 2-chars ({ "min": 2 })

var x = 5;
obj.e = document.body;
var foo = function (e) { };
try {
    dangerousStuff();
} catch (e) {
    // ignore as many do
}
var myObj = { a: 1 };
(a) => { a * a };
class y { }
class Foo { x() {} }
class Bar { #x() {} }
class Baz { x = 1 }
class Qux { #x = 1 }
function bar(...x) { }
function baz([x]) { }
var [x] = arr;
var { prop: [x]} = {};
function qux({x}) { }
var { x } = {};
var { prop: a} = {};
({ prop: obj.x } = {});

使用默认选项的此规则的正确代码示例：

¥Examples of correct code for this rule with the default options:

在线运行 
/*eslint id-length: "error"*/     // default is minimum 2-chars ({ "min": 2 })

var num = 5;
function _f() { return 42; }
function _func() { return 42; }
obj.el = document.body;
var foo = function (evt) { /* do stuff */ };
try {
    dangerousStuff();
} catch (error) {
    // ignore as many do
}
var myObj = { apple: 1 };
(num) => { num * num };
function bar(num = 0) { }
class MyClass { }
class Foo { method() {} }
class Bar { #method() {} }
class Baz { field = 1 }
class Qux { #field = 1 }
function baz(...args) { }
function qux([longName]) { }
var { prop } = {};
var { prop: [longName] } = {};
var [longName] = arr;
function foobar({ prop }) { }
function foobaz({ a: prop }) { }
var { prop } = {};
var { a: prop } = {};
({ prop: obj.longName } = {});
var data = { "x": 1 };  // excused because of quotes
data["y"] = 3;  // excused because of calculated property access

此规则有一个对象选项：

¥This rule has an object option:

  • "min"（默认值：2）强制执行最小标识符长度

    ¥"min" (default: 2) enforces a minimum identifier length

  • "max"（默认值：无穷大）强制最大标识符长度

    ¥"max" (default: Infinity) enforces a maximum identifier length

  • "properties": always（默认）强制属性名称的标识符长度约定

    ¥"properties": always (default) enforces identifier length convention for property names

  • "properties": never 忽略属性名称的标识符长度约定

    ¥"properties": never ignores identifier length convention for property names

  • "exceptions" 允许指定标识符名称的数组

    ¥"exceptions" allows an array of specified identifier names

  • "exceptionPatterns" 表示正则表达式模式的字符串数组，允许与任何模式匹配的标识符。

    ¥"exceptionPatterns" array of strings representing regular expression patterns, allows identifiers that match any of the patterns.

min

使用 { "min": 4 } 选项的此规则的错误代码示例：

¥Examples of incorrect code for this rule with the { "min": 4 } option:

在线运行 
/*eslint id-length: ["error", { "min": 4 }]*/

var val = 5;
obj.e = document.body;
function foo (e) { };
try {
    dangerousStuff();
} catch (e) {
    // ignore as many do
}
var myObj = { a: 1 };
(val) => { val * val };
class y { }
class Foo { x() {} }
function bar(...x) { }
var { x } = {};
var { prop: a} = {};
var [x] = arr;
var { prop: [x]} = {};
({ prop: obj.x } = {});

使用 { "min": 4 } 选项的此规则的正确代码示例：

¥Examples of correct code for this rule with the { "min": 4 } option:

在线运行 
/*eslint id-length: ["error", { "min": 4 }]*/

var value = 5;
function func() { return 42; }
object.element = document.body;
var foobar = function (event) { /* do stuff */ };
try {
    dangerousStuff();
} catch (error) {
    // ignore as many do
}
var myObj = { apple: 1 };
(value) => { value * value };
function foobaz(value = 0) { }
class MyClass { }
class Foobar { method() {} }
function barbaz(...args) { }
var { prop } = {};
var [longName] = foo;
var { a: [prop] } = {};
var { a: longName } = {};
({ prop: object.name } = {});
var data = { "x": 1 };  // excused because of quotes
data["y"] = 3;  // excused because of calculated property access

max

使用 { "max": 10 } 选项的此规则的错误代码示例：

¥Examples of incorrect code for this rule with the { "max": 10 } option:

在线运行 
/*eslint id-length: ["error", { "max": 10 }]*/

var reallyLongVarName = 5;
function reallyLongFuncName() { return 42; }
obj.reallyLongPropName = document.body;
var foo = function (reallyLongArgName) { /* do stuff */ };
try {
    dangerousStuff();
} catch (reallyLongErrorName) {
    // ignore as many do
}
(reallyLongArgName) => { return !reallyLongArgName; };
var [reallyLongFirstElementName] = arr;

使用 { "max": 10 } 选项的此规则的正确代码示例：

¥Examples of correct code for this rule with the { "max": 10 } option:

在线运行 
/*eslint id-length: ["error", { "max": 10 }]*/

var varName = 5;
function funcName() { return 42; }
obj.propName = document.body;
var foo = function (arg) { /* do stuff */ };
try {
    dangerousStuff();
} catch (error) {
    // ignore as many do
}
(arg) => { return !arg; };
var [first] = arr;

properties

使用 { "properties": "never" } 选项的此规则的正确代码示例：

¥Examples of correct code for this rule with the { "properties": "never" } option:

在线运行 
/*eslint id-length: ["error", { "properties": "never" }]*/

var myObj = { a: 1 };
({ a: obj.x.y.z } = {});
({ prop: obj.i } = {});

exceptions

使用 { "exceptions": ["x", "y", "z", "ζ"] } 选项的此规则的附加正确代码示例：

¥Examples of additional correct code for this rule with the { "exceptions": ["x", "y", "z", "ζ"] } option:

在线运行 
/*eslint id-length: ["error", { "exceptions": ["x", "y", "z", "ζ"] }]*/

var x = 5;
function y() { return 42; }
obj.x = document.body;
var foo = function (x) { /* do stuff */ };
try {
    dangerousStuff();
} catch (x) {
    // ignore as many do
}
(x) => { return x * x; };
var [x] = arr;
const { z } = foo;
const { a: ζ } = foo;

exceptionPatterns

使用 { "exceptionPatterns": ["E|S", "[x-z]"] } 选项的此规则的附加正确代码示例：

¥Examples of additional correct code for this rule with the { "exceptionPatterns": ["E|S", "[x-z]"] } option:

在线运行 
/*eslint id-length: ["error", { "exceptionPatterns": ["E|S", "[x-z]"] }]*/

var E = 5;
function S() { return 42; }
obj.x = document.body;
var foo = function (x) { /* do stuff */ };
try {
    dangerousStuff();
} catch (x) {
    // ignore as many do
}
(y) => {return  y * y};
var [E] = arr;
const { y } = foo;
const { a: z } = foo;

版本

此规则是在 ESLint v1.0.0 中引入。

资源

ESLint 中文网
粤ICP备13048890号