非常教程

Eslint参考手册

规则 | Rules

consistent-return

与强制函数返回指定类型的值的静态类型语言不同,JavaScript 允许函数中的不同代码路径返回不同类型的值。

JavaScript 的一个令人困惑的方面是,undefined如果满足以下任一条件,函数将返回:

  • return在退出之前不执行语句
  • 它执行时return没有明确指定一个值
  • 它执行 return undefined
  • 它执行return void后跟一个表达式(例如,一个函数调用)
  • 它执行return之后是任何其他表达式,评估为undefined

如果某个函数中的任何代码路径显式返回一个值,但某些代码路径不会显式返回值,则可能是输入错误,特别是在大型函数中。在以下示例中:

  • 通过该函数的代码路径返回一个 Boolean 值 true
  • 另一个代码路径不显式返回值,因此隐式返回undefined
function doSomething(condition) {
    if (condition) {
        return true;
    } else {
        return;
    }
}

规则细节

规则要求return语句总是或永远不指定值。此规则忽略名称以大写字母开头的函数定义,因为构造函数(当用new运算符调用时)隐式返回实例化对象,如果它们不显式返回另一个对象。

规则的错误代码示例:

/*eslint consistent-return: "error"*/

function doSomething(condition) {
    if (condition) {
        return true;
    } else {
        return;
    }
}

function doSomething(condition) {
    if (condition) {
        return true;
    }
}

规则的正确代码示例:

/*eslint consistent-return: "error"*/

function doSomething(condition) {
    if (condition) {
        return true;
    } else {
        return false;
    }
}

function Foo() {
    if (!(this instanceof Foo)) {
        return new Foo();
    }

    this.a = 0;
}

选项

规则有一个对象选项:

  • "treatUndefinedAsUnspecified": false(默认)总是指定值或仅隐式返回undefined
  • "treatUndefinedAsUnspecified": true总是指定值或undefined显式或隐式返回。

treatUndefinedAsUnspecified

{ "treatUndefinedAsUnspecified": false }规则的默认代码错误代码示例:

/*eslint consistent-return: ["error", { "treatUndefinedAsUnspecified": false }]*/

function foo(callback) {
    if (callback) {
        return void callback();
    }
    // no return statement
}

function bar(condition) {
    if (condition) {
        return undefined;
    }
    // no return statement
}

{ "treatUndefinedAsUnspecified": true }规则的错误代码示例包含以下选项:

/*eslint consistent-return: ["error", { "treatUndefinedAsUnspecified": true }]*/

function foo(callback) {
    if (callback) {
        return void callback();
    }
    return true;
}

function bar(condition) {
    if (condition) {
        return undefined;
    }
    return true;
}

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

/*eslint consistent-return: ["error", { "treatUndefinedAsUnspecified": true }]*/

function foo(callback) {
    if (callback) {
        return void callback();
    }
    // no return statement
}

function bar(condition) {
    if (condition) {
        return undefined;
    }
    // no return statement
}

何时不使用它

如果您想允许函数return根据代码分支具有不同的行为,那么禁用此规则是安全的。

版本

规则是在ESLint 0.4.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-this
22.constructor-super
23.curly
24.default-case
25.dot-location
26.dot-notation
27.eol-last
28.eqeqeq
29.for-direction
30.func-call-spacing
31.func-name-matching
32.func-names
33.func-style
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