驼峰命名法

强制执行驼峰命名约定

在变量命名方面，风格指南通常分为两类：驼峰命名法 (variableName) 和下划线 (variable_name)。此规则侧重于使用驼峰命名法。如果您的风格指南要求您使用驼峰命名法命名变量，那么此规则适合您！

规则详细信息

此规则查找源代码中任何下划线 (_)。它忽略开头和结尾的下划线，并且只检查变量名称中间的下划线。如果 ESLint 确定该变量是常量（全部大写），则不会发出警告。否则，将发出警告。此规则仅标记定义和赋值，而不标记函数调用。对于 ES6 import 语句，此规则仅针对将导入到本地模块作用域的变量的名称。

选项

此规则有一个对象选项

"properties": "always"（默认）强制对属性名称使用驼峰命名法
"properties": "never" 不检查属性名称
"ignoreDestructuring": false（默认）强制对解构标识符使用驼峰命名法
"ignoreDestructuring": true 不检查解构标识符（但仍检查代码后面对这些标识符的任何使用）
"ignoreImports": false（默认）强制对 ES2015 导入使用驼峰命名法
"ignoreImports": true 不检查 ES2015 导入（但仍检查代码后面对导入的任何使用，除了函数参数）
"ignoreGlobals": false（默认）强制对全局变量使用驼峰命名法
"ignoreGlobals": true 不强制对全局变量使用驼峰命名法
allow（string[]）要接受的属性列表。接受正则表达式。

properties: “always”

使用默认 { "properties": "always" } 选项时，此规则的不正确代码示例

在游乐场中打开

/*eslint camelcase: "error"*/

import { no_camelcased } from "external-module"

var my_favorite_color = "#112C85";

function do_something() {
    // ...
}

obj.do_something = function() {
    // ...
};

function foo({ no_camelcased }) {
    // ...
};

function bar({ isCamelcased: no_camelcased }) {
    // ...
}

function baz({ no_camelcased = 'default value' }) {
    // ...
};

var obj = {
    my_pref: 1
};

var { category_id = 1 } = query;

var { foo: snake_cased } = bar;

var { foo: bar_baz = 1 } = quz;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

使用默认 { "properties": "always" } 选项时，此规则的正确代码示例

在游乐场中打开

/*eslint camelcase: "error"*/

import { no_camelcased as camelCased } from "external-module";

var myFavoriteColor   = "#112C85";
var _myFavoriteColor  = "#112C85";
var myFavoriteColor_  = "#112C85";
var MY_FAVORITE_COLOR = "#112C85";
var foo1 = bar.baz_boom;
var foo2 = { qux: bar.baz_boom };

obj.do_something();
do_something();
new do_something();

var { category_id: category } = query;

function foo({ isCamelCased }) {
    // ...
};

function bar({ isCamelCased: isAlsoCamelCased }) {
    // ...
}

function baz({ isCamelCased = 'default value' }) {
    // ...
};

var { categoryId = 1 } = query;

var { foo: isCamelCased } = bar;

var { foo: isCamelCased = 1 } = quz;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

properties: “never”

使用 { "properties": "never" } 选项时，此规则的正确代码示例

在游乐场中打开

/*eslint camelcase: ["error", {properties: "never"}]*/

var obj = {
    my_pref: 1
};

obj.foo_bar = "baz";
1
2
3
4
5
6
7

ignoreDestructuring: false

使用默认 { "ignoreDestructuring": false } 选项时，此规则的不正确代码示例

在游乐场中打开

/*eslint camelcase: "error"*/

var { category_id } = query;

var { category_name = 1 } = query;

var { category_id: category_title } = query;

var { category_id: category_alias } = query;

var { category_id: categoryId, ...other_props } = query;
1
2
3
4
5
6
7
8
9
10
11

ignoreDestructuring: true

使用 { "ignoreDestructuring": true } 选项时，此规则的不正确代码示例

在游乐场中打开

/*eslint camelcase: ["error", {ignoreDestructuring: true}]*/

var { category_id: category_alias } = query;

var { category_id, ...other_props } = query;
1
2
3
4
5

使用 { "ignoreDestructuring": true } 选项时，此规则的正确代码示例

在游乐场中打开

/*eslint camelcase: ["error", {ignoreDestructuring: true}]*/

var { category_id } = query;

var { category_id = 1 } = query;

var { category_id: category_id } = query;
1
2
3
4
5
6
7

请注意，此选项仅适用于解构模式内的标识符。它不会额外允许代码后面对已创建变量的任何特定使用，除了默认或其他选项已允许的使用之外。

使用 { "ignoreDestructuring": true } 选项时，此规则的其他不正确代码示例

在游乐场中打开

/*eslint camelcase: ["error", {ignoreDestructuring: true}]*/

var { some_property } = obj; // allowed by {ignoreDestructuring: true}
var foo = some_property + 1; // error, ignoreDestructuring does not apply to this statement
1
2
3
4

此选项的一个常见用例是在标识符不打算在代码后面使用时避免无用的重命名。

使用 { "ignoreDestructuring": true } 选项时，此规则的其他正确代码示例

在游乐场中打开

/*eslint camelcase: ["error", {ignoreDestructuring: true}]*/

var { some_property, ...rest } = obj;
// do something with 'rest', nothing with 'some_property'
1
2
3
4

此选项的另一个常见用例是与 { "properties": "never" } 结合使用，当标识符仅打算用作属性简写时。

使用 { "properties": "never", "ignoreDestructuring": true } 选项时，此规则的其他正确代码示例

在游乐场中打开

/*eslint camelcase: ["error", {"properties": "never", ignoreDestructuring: true}]*/

var { some_property } = obj;
doSomething({ some_property });
1
2
3
4

ignoreImports: false

使用默认 { "ignoreImports": false } 选项时，此规则的不正确代码示例

在游乐场中打开

/*eslint camelcase: "error"*/

import { snake_cased } from 'mod';
1
2
3

ignoreImports: true

使用 { "ignoreImports": true } 选项时，此规则的不正确代码示例

在游乐场中打开

/*eslint camelcase: ["error", {ignoreImports: true}]*/

import default_import from 'mod';

import * as namespaced_import from 'mod';
1
2
3
4
5

使用 { "ignoreImports": true } 选项时，此规则的正确代码示例

在游乐场中打开

/*eslint camelcase: ["error", {ignoreImports: true}]*/

import { snake_cased } from 'mod';
1
2
3

ignoreGlobals: false

使用默认 { "ignoreGlobals": false } 选项时，此规则的不正确代码示例

在游乐场中打开

/*eslint camelcase: ["error", {ignoreGlobals: false}]*/
/* global no_camelcased */

const foo = no_camelcased;
1
2
3
4

ignoreGlobals: true

使用 { "ignoreGlobals": true } 选项时，此规则的正确代码示例

在游乐场中打开

/*eslint camelcase: ["error", {ignoreGlobals: true}]*/
/* global no_camelcased */

const foo = no_camelcased;
1
2
3
4

允许

使用 allow 选项时，此规则的正确代码示例

在游乐场中打开

/*eslint camelcase: ["error", {allow: ["UNSAFE_componentWillMount"]}]*/

function UNSAFE_componentWillMount() {
    // ...
}
1
2
3
4
5

在游乐场中打开

/*eslint camelcase: ["error", {allow: ["^UNSAFE_"]}]*/

function UNSAFE_componentWillMount() {
    // ...
}

function UNSAFE_componentWillReceiveProps() {
    // ...
}
1
2
3
4
5
6
7
8
9

何时不使用它

如果您已使用不同的命名约定（使用下划线分隔单词）建立了编码标准，请关闭此规则。

版本

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

资源

编辑此页面