Eslint参考手册
规则 | Rules
func-style
在 JavaScript 中定义函数有两种方法:function
声明和function
表达式。声明function
首先包含关键字,后跟一个名称,然后是它的参数和函数体,例如:
function doSomething() {
// ...
}
等价函数表达式以var
关键字开头,后跟一个名称,然后是函数本身,如:
var doSomething = function() {
// ...
};
function
声明之间的主要区别在于声明function expressions
被提升到定义范围的顶部,这允许您在声明之前编写使用该函数的代码。例如:
doSomething();
function doSomething() {
// ...
}
尽管这段代码看起来像是一个错误,但它实际上工作正常,因为 JavaScript 引擎将function
声明提升到作用域的顶部。这意味着这个代码被视为声明在调用之前被处理。
对于function
表达式,您必须在使用该函数之前定义该函数,否则会导致错误。例:
doSomething(); // error!
var doSomething = function() {
// ...
};
在这种情况下,doSomething()
在调用时未定义,因此会导致运行时错误。
由于这些不同的行为,通常应该使用哪种风格的功能。这里确实没有正确或不正确的选择,它只是一种偏好。
规则细节
此规则function
在整个 JavaScript 文件中强制执行特定类型的样式,声明或表达式。您可以指定您在配置中的首选项。
选项
这条规则有一个字符串选项:
-
"expression"
(默认)需要使用函数表达式而不是函数声明 -
"declaration"
需要使用函数声明而不是函数表达式
此规则具有异常的对象选项:
-
"allowArrowFunctions": true
(默认false
)允许使用箭头功能
expression
此规则的默认代码错误代码示例"expression"
:
/*eslint func-style: ["error", "expression"]*/
function foo() {
// ...
}
具有默认选项的此规则的正确代码示例"expression"
:
/*eslint func-style: ["error", "expression"]*/
var foo = function() {
// ...
};
declaration
此规则的错误代码示例包含以下"declaration"
选项:
/*eslint func-style: ["error", "declaration"]*/
var foo = function() {
// ...
};
var foo = () => {};
此规则的正确代码示例包含以下"declaration"
选项:
/*eslint func-style: ["error", "declaration"]*/
function foo() {
// ...
}
// Methods (functions assigned to objects) are not checked by this rule
SomeObject.foo = function() {
// ...
};
allowArrowFunctions
此规则的附加正确代码示例包含以下"declaration", { "allowArrowFunctions": true }
选项:
/*eslint func-style: ["error", "declaration", { "allowArrowFunctions": true }]*/
var foo = () => {};
何时不使用它
如果你想让开发者分别决定他们自己编写函数的方式,那么你可以禁用这个规则。
进一步阅读
- JavaScript Scoping and Hoisting
版本
该规则在 ESLint 0.2.0 中引入。
资源
- 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 |