非常教程

Eslint参考手册

规则 | Rules

new-cap

newJavaScript中的运算符创建特定类型对象的新实例。该类型的对象由构造函数表示。由于构造函数只是常规函数,因此唯一的定义特征是new作为调用的一部分使用。原生JavaScript函数以大写字母开头,以区分将用作构造函数的那些函数与不用的函数。许多样式指南建议遵循此模式,以便更轻松地确定哪些函数将用作构造函数。

var friend = new Person();

规则细节

此规则要求构造函数名以大写字母开头。某些内置标识符可免除此规则。这些标识符是:

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

此规则的正确代码示例:

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

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

选项

该规则有一个对象选项:

  • "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();

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

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

var friend = new Person();

此规则的正确代码示例包含以下{ "newIsCap": false }选项:

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

var friend = new person();

capIsNew

此规则的默认代码错误代码示例{ "capIsNew": true }

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

var colleague = Person();

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

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

var colleague = new Person();

此规则的正确代码示例包含以下{ "capIsNew": false }选项:

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

var colleague = Person();

newIsCapExceptions

此规则的附加正确代码示例包含以下{ "newIsCapExceptions": ["events"] }选项:

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

var events = require('events');

var emitter = new events();

newIsCapExceptionPattern

此规则的附加正确代码示例包含以下{ "newIsCapExceptionPattern": "^person\.." }选项:

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

var friend = new person.acquaintance();
var bestFriend = new person.friend();

capIsNewExceptions

此规则的附加正确代码示例包含以下{ "capIsNewExceptions": ["Person"] }选项:

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

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

capIsNewExceptionPattern

此规则的附加正确代码示例包含以下{ "capIsNewExceptionPattern": "^Person\.." }选项:

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

var friend = person.Acquaintance();
var bestFriend = person.Friend();

属性

此规则的默认代码错误代码示例{ "properties": true }

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

var friend = new person.acquaintance();

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

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

var friend = new person.Acquaintance();

此规则的正确代码示例包含以下{ "properties": false }选项:

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

var friend = new person.acquaintance();

何时不使用它

如果您的约定不需要构造函数的大写字母,或者不需要大写的函数只能用作构造函数,请关闭此规则。

版本

该规则在ESLint 0.0.3-0中引入。

资源

  • 规则来源
  • 文档来源

规则 | Rules相关

1.accessor-pairs
2.array-bracket-newline
3.array-bracket-spacing
4.array-callback-return
5.array-element-newline
6.arrow-body-style
7.arrow-parens
8.arrow-spacing
9.block-scoped-var
10.block-spacing
11.brace-style
12.callback-return
13.camelcase
14.capitalized-comments
15.class-methods-use-this
16.comma-dangle
17.comma-spacing
18.comma-style
19.complexity
20.computed-property-spacing
21.consistent-return
22.consistent-this
23.constructor-super
24.curly
25.default-case
26.dot-location
27.dot-notation
28.eol-last
29.eqeqeq
30.for-direction
31.func-call-spacing
32.func-name-matching
33.func-names
34.func-style
35.function-paren-newline
36.generator-star
37.generator-star-spacing
38.getter-return
39.global-require
40.global-strict
41.guard-for-in
42.handle-callback-err
43.id-blacklist
44.id-length
45.id-match
46.implicit-arrow-linebreak
47.indent
48.indent-legacy
49.init-declarations
50.jsx-quotes
51.key-spacing
52.keyword-spacing
53.line-comment-position
54.linebreak-style
55.lines-around-comment
56.lines-around-directive
57.lines-between-class-members
58.max-depth
59.max-len
60.max-lines
61.max-nested-callbacks
62.max-params
63.max-statements
64.max-statements-per-line
65.multiline-comment-style
66.multiline-ternary
67.new-parens
68.newline-after-var
69.newline-before-return
70.newline-per-chained-call
71.no-alert
72.no-array-constructor
73.no-arrow-condition
74.no-await-in-loop
75.no-bitwise
76.no-buffer-constructor
77.no-caller
78.no-case-declarations
79.no-catch-shadow
80.no-class-assign
81.no-comma-dangle
82.no-compare-neg-zero
83.no-cond-assign
84.no-confusing-arrow
85.no-console
86.no-const-assign
87.no-constant-condition
88.no-continue
89.no-control-regex
90.no-debugger
91.no-delete-var
92.no-div-regex
93.no-dupe-args
94.no-dupe-class-members
95.no-dupe-keys
96.no-duplicate-case
97.no-duplicate-imports
98.no-else-return
99.no-empty
100.no-empty-character-class
Eslint

ESLint 是一个代码规范和错误检查工具,有以下几个特性。所有东西都是可以插拔的。你可以调用任意的 rule api 或者 formatter api 去打包或者定义 rule or formatter。任意的 rule 都是独立的。没有特定的 coding style,你可以自己配置。

主页 https://eslint.org/
源码 https://github.com/eslint/eslint
发布版本 4.12.0

Eslint目录

1.指南 | Guide
2.规则 | Rules