非常教程

Eslint参考手册

规则 | Rules

handle-callback-err

在 Node.js 中,处理异步行为的常见模式称为回调模式。此模式需要一个Error对象或null作为回调的第一个参数。忘记处理这些错误可能会导致应用程序中出现一些非常奇怪的行为。

function loadData (err, data) {
    doSomething(); // forgot to handle error
}

规则细节

这个规则期望当你在 Node.js 中使用回调模式时,你会处理这个错误。

选项

该规则采用单个字符串选项:错误参数的名称。默认是"err"

使用默认参数名称的此规则的代码不正确的示例"err"

/*eslint handle-callback-err: "error"*/

function loadData (err, data) {
    doSomething();
}

具有默认参数名称的此规则的正确代码示例"err"

/*eslint handle-callback-err: "error"*/

function loadData (err, data) {
    if (err) {
        console.log(err.stack);
    }
    doSomething();
}

function generateError (err) {
    if (err) {}
}

具有示例参数名称的此规则的正确代码示例"error"

/*eslint handle-callback-err: ["error", "error"]*/

function loadData (error, data) {
    if (error) {
       console.log(error.stack);
    }
    doSomething();
}

正则表达式

有时(特别是在大型项目中)错误变量的名称在项目中不一致,因此您需要更灵活的配置以确保规则报告所有未处理的错误。

如果错误变量的配置名称以 a 开头,^则认为它是正则表达式模式。

  • 如果选项是"^(err|error|anySpecificError)$",则该规则会报告参数名称可能出现的未处理错误errerroranySpecificError
  • 如果选项是"^.+Error$",则规则报告参数名以Error(例如,connectionErrorvalidationError将匹配)结尾的未处理的错误。
  • 如果选择是"^.*(e|E)rr",该规则报告,其中的参数名称中包含任何字符串匹配未处理的错误errErr(例如errerroranyErrorsome_err将匹配)。

何时不使用它

在某些情况下,您的应用程序可能会安全地忽略错误,但是如果您确信某种其他形式的监控可以帮助您解决问题,则只会忽略错误。

进一步阅读

  • The Art Of Node: Callbacks
  • Nodejitsu: What are the error conventions?

版本

该规则在 ESLint 0.4.5 中引入。

资源

  • 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.func-style
35.function-paren-newline
36.generator-star
37.generator-star-spacing
38.getter-return
39.global-require
40.global-strict
41.guard-for-in
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