非常教程

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相关

1.accessor-pairs
2.array-bracket-newline
3.array-bracket-spacing
4.array-callback-return
5.array-element-newline
6.arrow-body-style
7.arrow-parens
8.arrow-spacing
9.block-scoped-var
10.block-spacing
11.brace-style
12.callback-return
13.camelcase
14.capitalized-comments
15.class-methods-use-this
16.comma-dangle
17.comma-spacing
18.comma-style
19.complexity
20.computed-property-spacing
21.consistent-return
22.consistent-this
23.constructor-super
24.curly
25.default-case
26.dot-location
27.dot-notation
28.eol-last
29.eqeqeq
30.for-direction
31.func-call-spacing
32.func-name-matching
33.func-names
34.function-paren-newline
35.generator-star
36.generator-star-spacing
37.getter-return
38.global-require
39.global-strict
40.guard-for-in
41.handle-callback-err
42.id-blacklist
43.id-length
44.id-match
45.implicit-arrow-linebreak
46.indent
47.indent-legacy
48.init-declarations
49.jsx-quotes
50.key-spacing
51.keyword-spacing
52.line-comment-position
53.linebreak-style
54.lines-around-comment
55.lines-around-directive
56.lines-between-class-members
57.max-depth
58.max-len
59.max-lines
60.max-nested-callbacks
61.max-params
62.max-statements
63.max-statements-per-line
64.multiline-comment-style
65.multiline-ternary
66.new-cap
67.new-parens
68.newline-after-var
69.newline-before-return
70.newline-per-chained-call
71.no-alert
72.no-array-constructor
73.no-arrow-condition
74.no-await-in-loop
75.no-bitwise
76.no-buffer-constructor
77.no-caller
78.no-case-declarations
79.no-catch-shadow
80.no-class-assign
81.no-comma-dangle
82.no-compare-neg-zero
83.no-cond-assign
84.no-confusing-arrow
85.no-console
86.no-const-assign
87.no-constant-condition
88.no-continue
89.no-control-regex
90.no-debugger
91.no-delete-var
92.no-div-regex
93.no-dupe-args
94.no-dupe-class-members
95.no-dupe-keys
96.no-duplicate-case
97.no-duplicate-imports
98.no-else-return
99.no-empty
100.no-empty-character-class
Eslint

ESLint 是一个代码规范和错误检查工具,有以下几个特性。所有东西都是可以插拔的。你可以调用任意的 rule api 或者 formatter api 去打包或者定义 rule or formatter。任意的 rule 都是独立的。没有特定的 coding style,你可以自己配置。

主页 https://eslint.org/
源码 https://github.com/eslint/eslint
发布版本 4.12.0

Eslint目录

1.指南 | Guide
2.规则 | Rules