dot-notation

尽可能强制使用点号表示法

在 JavaScript 中，可以使用点号表示法 (foo.bar) 或方括号表示法 (foo["bar"]) 访问属性。然而，点号表示法通常更受欢迎，因为它更易于阅读，更简洁，并且更适用于激进的 JavaScript 压缩器。

foo["bar"];
1

规则详情

此规则旨在通过尽可能鼓励使用点号表示法风格来保持代码一致性和提高代码可读性。因此，当它遇到不必要的方括号表示法使用时，它会发出警告。

此规则的 错误 代码示例

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

const x = foo["bar"];
1
2
3

此规则的 正确 代码示例

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

const x = foo.bar;

const y = foo[bar];    // Property name is a variable, square-bracket notation required
1
2
3
4
5

选项

此规则接受一个 options 参数

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

allowKeywords

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

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

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

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

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

class C {
    #in;
    foo() {
        this.#in; // Dot notation is required for private identifiers
    }
}
1
2
3
4
5
6
7
8

allowPattern

例如，当准备要发送到外部 API 的数据时，通常需要使用包含下划线的属性名。如果 camelcase 规则生效，则这些 蛇形命名 属性将不被允许。通过为 dot-notation 规则提供 allowPattern，可以使用方括号表示法访问这些蛇形命名属性。

示例 { "allowPattern": "^[a-z]+(_[a-z]+)+$" } (查找蛇形命名属性的模式) 选项的 错误 代码示例

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

const data = {};
data["fooBar"] = 42;
1
2
3
4

示例 { "allowPattern": "^[a-z]+(_[a-z]+)+$" } (查找蛇形命名属性的模式) 选项的 正确 代码示例

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

const data = {};
data["foo_bar"] = 42;
1
2
3
4

版本

此规则在 ESLint v0.0.7 中引入。

资源

• 规则源码
• 测试源码