非常教程

Eslint参考手册

规则 | Rules

dot-notation

--fix命令行上的选项可以自动修复一些被这条规则反映的问题。

在 JavaScript 中,可以使用点符号(foo.bar)或方括号表示法(foo["bar"])来访问属性。但是,点符号通常是首选,因为它更易于阅读,不会太冗长,而且在侵略性 JavaScript 最小化器中效果更好。

foo["bar"];

规则细节

此规则旨在通过鼓励尽可能使用点符号样式来维护代码一致性并提高代码可读性。因此,它会在遇到不必要的方括号表示法时发出警告。

此规则的错误代码示例:

/*eslint dot-notation: "error"*/

var x = foo["bar"];

此规则的正确代码示例:

/*eslint dot-notation: "error"*/

var x = foo.bar;

var x = foo[bar];    // Property name is a variable, square-bracket notation required

选项

该规则接受单个选项参数:

  • 将该allowKeywords选项设置为false(默认为true)以遵循 ECMAScript版本3 兼容样式,避免使用保留字属性的点符号。
  • 将该allowPattern选项设置为正则表达式字符串以允许与模式匹配的属性名称使用括号表示法(默认情况下,未测试模式)。

allowKeywords

选项的正确代码示例{ "allowKeywords": false }

/*eslint dot-notation: ["error", { "allowKeywords": false }]*/

var foo = { "class": "CS 101" }
var x = foo["class"]; // Property name is a reserved word, square-bracket notation required

allowPattern

例如,在准备发送到外部 API 的数据时,通常需要使用包含下划线的属性名称。如果camelcase规则生效,这些蛇情况属性将不被允许。通过提供一种allowPatterndot-notation规则,这些蛇例特征可以与托架符号来访问。

示例选项的正确代码示例{ "allowPattern": "^[a-z]+(_[a-z]+)+$" }

/*eslint camelcase: "error"*/
/*eslint dot-notation: ["error", { "allowPattern": "^[a-z]+(_[a-z]+)+$" }]*/

var data = {};
data.foo_bar = 42;

var data = {};
data["fooBar"] = 42;

var data = {};
data["foo_bar"] = 42; // no warning

版本

该规则在 ESLint 0.0.7 中引入。

资源

  • Rule source
  • Documentation source

规则 | 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.eol-last
28.eqeqeq
29.for-direction
30.func-call-spacing
31.func-name-matching
32.func-names
33.func-style
34.function-paren-newline
35.generator-star
36.generator-star-spacing
37.getter-return
38.global-require
39.global-strict
40.guard-for-in
41.handle-callback-err
42.id-blacklist
43.id-length
44.id-match
45.implicit-arrow-linebreak
46.indent
47.indent-legacy
48.init-declarations
49.jsx-quotes
50.key-spacing
51.keyword-spacing
52.line-comment-position
53.linebreak-style
54.lines-around-comment
55.lines-around-directive
56.lines-between-class-members
57.max-depth
58.max-len
59.max-lines
60.max-nested-callbacks
61.max-params
62.max-statements
63.max-statements-per-line
64.multiline-comment-style
65.multiline-ternary
66.new-cap
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