在线文档教程
Eslint
规则 | Rules

camelcase

要求 Camelcase(camelcase)

在命名变量时,风格指南通常属于两个阵营之一: camelcase(variableName)和 underscores(variable_name)。这条规则着重于使用 camelcase 方法。如果你的风格指南要求提供你的变量名,那么这个规则适合你!

规则细节

规则查找_位于源代码内的任何下划线()。它会忽略前导和尾随下划线,并只检查变量名称中间的那些下划线。如果 ESLint 确定该变量是一个常量(全部大写),则不会引发警告。否则,会引发警告。此规则仅标记定义和分配,但不标记函数调用。在 ES6 import语句的情况下,该规则仅针对将被导入本地模块范围的变量的名称。

选项

规则有一个对象选项:

  • "properties": "always" (默认)为属性名称强制执行 camelcase 样式

  • "properties": "never" 不检查属性名称

always

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

/*eslint camelcase: "error"*/ import { no_camelcased } from "external-module" var my_favorite_color = "#112C85"; function do_something() { // ... } obj.do_something = function() { // ... }; var obj = { my_pref: 1 };

具有默认选项的规则的正确代码示例{ "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 foo = bar.baz_boom; var foo = { qux: bar.baz_boom }; obj.do_something( do_something( new do_something( var { category_id: category } = query;

never

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

/*eslint camelcase: ["error", {properties: "never"}]*/ var obj = { my_pref: 1 };

何时不使用它

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

版本

这条规则是在 ESLint 0.0.2 中引入的。

资源