new-cap

要求构造函数名称以大写字母开头

JavaScript 中的 new 运算符创建一个特定类型对象的实例。该对象类型由构造函数表示。由于构造函数只是普通的函数，因此唯一定义的特征是 new 被用作调用的一部分。原生 JavaScript 函数以大写字母开头，以区分用作构造函数的函数和不用作构造函数的函数。许多风格指南建议遵循此模式，以便更容易地确定哪些函数应该用作构造函数。

var friend = new Person();
1

规则详细信息

此规则要求构造函数名称以大写字母开头。某些内置标识符不受此规则的约束。这些标识符是

• Array
• Boolean
• Date
• Error
• Function
• Number
• Object
• RegExp
• String
• Symbol
• BigInt

此规则的 正确 代码示例

/*eslint new-cap: "error"*/

function foo(arg) {
    return Boolean(arg);
}
1
2
3
4
5

选项

此规则有一个对象选项

• "newIsCap": true（默认）要求所有 new 运算符使用以大写字母开头的函数调用。
• "newIsCap": false 允许 new 运算符使用以小写字母开头或以大写字母开头的函数调用。
• "capIsNew": true（默认）要求所有以大写字母开头的函数使用 new 运算符调用。
• "capIsNew": false 允许以大写字母开头的函数在没有 new 运算符的情况下调用。
• "newIsCapExceptions" 允许使用 new 运算符调用指定的小写字母开头的函数名称。
• "newIsCapExceptionPattern" 允许使用 new 运算符调用与指定正则表达式模式匹配的任何小写字母开头的函数名称。
• "capIsNewExceptions" 允许在没有 new 运算符的情况下调用指定的大写字母开头的函数名称。
• "capIsNewExceptionPattern" 允许在没有 new 运算符的情况下调用与指定正则表达式模式匹配的任何大写字母开头的函数名称。
• "properties": true（默认）启用对对象属性的检查
• "properties": false 禁用对对象属性的检查

newIsCap

使用默认 { "newIsCap": true } 选项的此规则的 不正确 代码示例

/*eslint new-cap: ["error", { "newIsCap": true }]*/

var friend = new person();
1
2
3

使用默认 { "newIsCap": true } 选项的此规则的 正确 代码示例

/*eslint new-cap: ["error", { "newIsCap": true }]*/

var friend = new Person();
1
2
3

使用 { "newIsCap": false } 选项的此规则的 正确 代码示例

/*eslint new-cap: ["error", { "newIsCap": false }]*/

var friend = new person();
1
2
3

capIsNew

使用默认 { "capIsNew": true } 选项的此规则的 不正确 代码示例

/*eslint new-cap: ["error", { "capIsNew": true }]*/

var colleague = Person();
1
2
3

使用默认 { "capIsNew": true } 选项的此规则的 正确 代码示例

/*eslint new-cap: ["error", { "capIsNew": true }]*/

var colleague = new Person();
1
2
3

使用 { "capIsNew": false } 选项的此规则的 正确 代码示例

/*eslint new-cap: ["error", { "capIsNew": false }]*/

var colleague = Person();
1
2
3

newIsCapExceptions

使用 { "newIsCapExceptions": ["events"] } 选项的此规则的其他 正确 代码示例

/*eslint new-cap: ["error", { "newIsCapExceptions": ["events"] }]*/

var events = require('events');

var emitter = new events();
1
2
3
4
5

newIsCapExceptionPattern

使用 { "newIsCapExceptionPattern": "^person\\.." } 选项的此规则的其他 正确 代码示例

/*eslint new-cap: ["error", { "newIsCapExceptionPattern": "^person\\.." }]*/

var friend = new person.acquaintance();

var bestFriend = new person.friend();
1
2
3
4
5

使用 { "newIsCapExceptionPattern": "\\.bar$" } 选项的此规则的其他 正确 代码示例

/*eslint new-cap: ["error", { "newIsCapExceptionPattern": "\\.bar$" }]*/

var friend = new person.bar();
1
2
3

capIsNewExceptions

使用 { "capIsNewExceptions": ["Person"] } 选项的此规则的其他 正确 代码示例

/*eslint new-cap: ["error", { "capIsNewExceptions": ["Person"] }]*/

function foo(arg) {
    return Person(arg);
}
1
2
3
4
5

capIsNewExceptionPattern

使用 { "capIsNewExceptionPattern": "^person\\.." } 选项的此规则的其他 正确 代码示例

/*eslint new-cap: ["error", { "capIsNewExceptionPattern": "^person\\.." }]*/

var friend = person.Acquaintance();
var bestFriend = person.Friend();
1
2
3
4

使用 { "capIsNewExceptionPattern": "\\.Bar$" } 选项的此规则的其他 正确 代码示例

/*eslint new-cap: ["error", { "capIsNewExceptionPattern": "\\.Bar$" }]*/

foo.Bar();
1
2
3

使用 { "capIsNewExceptionPattern": "^Foo" } 选项的此规则的其他 正确 代码示例

/*eslint new-cap: ["error", { "capIsNewExceptionPattern": "^Foo" }]*/

var x = Foo(42);

var y = Foobar(42);

var z = Foo.Bar(42);
1
2
3
4
5
6
7

properties

使用默认 { "properties": true } 选项的此规则的 不正确 代码示例

/*eslint new-cap: ["error", { "properties": true }]*/

var friend = new person.acquaintance();
1
2
3

使用默认 { "properties": true } 选项的此规则的 正确 代码示例

/*eslint new-cap: ["error", { "properties": true }]*/

var friend = new person.Acquaintance();
1
2
3

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

/*eslint new-cap: ["error", { "properties": false }]*/

var friend = new person.acquaintance();
1
2
3

何时不使用它

如果您有不需要构造函数使用大写字母的约定，或者不需要将大写字母函数仅用作构造函数，请关闭此规则。

版本

此规则是在 ESLint v0.0.3-0 中引入的。

资源

• 规则来源
• 测试来源