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 中引入。

资源

• 规则源代码
• 测试源代码