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
规则生效,这些蛇情况属性将不被允许。通过提供一种allowPattern
与dot-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相关
ESLint 是一个代码规范和错误检查工具,有以下几个特性。所有东西都是可以插拔的。你可以调用任意的 rule api 或者 formatter api 去打包或者定义 rule or formatter。任意的 rule 都是独立的。没有特定的 coding style,你可以自己配置。
主页 | https://eslint.org/ |
源码 | https://github.com/eslint/eslint |
发布版本 | 4.12.0 |