非常教程

Eslint参考手册

规则 | Rules

linebreak-style

--fix命令行上的选项可以自动修复一些被这条规则反映的问题。

当许多人都有不同的编辑器,VCS 应用程序和操作系统时,可能会发生不同的行结尾由上述任何一种写入(特别是在将SourceTree 的 Windows 和 Mac版本一起使用时)。

在 Windows 操作系统中使用的换行符(换行符)通常是回车符(CR),后面是换行符(LF),使其成为回车换行符(CRLF),而Linux和Unix使用简单换行符(LF)。相应的控制序列"\n"(对于LF)和"\r\n"对于(CRLF)。

许多版本控制系统(如 git 和 subversion)可以自动确保正确的结局。但为了涵盖所有意外情况,您可以激活此规则。

规则细节

此规则强制执行统一的行结尾,而不受操作系统,VCS 或整个代码库中使用的编辑器的影响。

选项

这条规则有一个字符串选项:

  • "unix"(默认)强制使用Unix行结尾:\n对于LF。
  • "windows"强制使用Windows行结束符:\r\n用于CRLF。

unix

此规则的默认代码错误代码示例"unix"

/*eslint linebreak-style: ["error", "unix"]*/

var a = 'a'; // \r\n

具有默认选项的此规则的正确代码示例"unix"

/*eslint linebreak-style: ["error", "unix"]*/

var a = 'a', // \n
    b = 'b'; // \n
// \n
function foo(params) { // \n
    // do stuff \n
}// \n

windows

此规则的错误代码示例包含以下"windows"选项:

/*eslint linebreak-style: ["error", "windows"]*/

var a = 'a'; // \n

此规则的正确代码示例包含以下"windows"选项:

/*eslint linebreak-style: ["error", "windows"]*/

var a = 'a', // \r\n
    b = 'b'; // \r\n
// \r\n
function foo(params) { // \r\n
    // do stuff \r\n
} // \r\n

在版本控制系统中使用此规则

版本控制系统有时对换行符有特殊的行为。为了方便开发人员从不同平台为您的代码库做出贡献,您可能需要配置 VCS 以适当处理换行符。

例如,Windows 系统上 git 的默认行为是在检出文件时将 LF 换行转换为 CRLF,但在提交更改时将换行符存储为 LF。linebreak-style如果配置了该"unix"设置,这将导致规则报告错误,因为 ESLint 看到的文件将具有 CRLF 换行符。如果你使用 git,你可能想要添加一行到你的.gitattributes文件,以防止 git 转换.js文件中的换行符:

*.js text eol=lf

何时不使用它

如果您不担心代码中有不同的行尾,那么您可以放心地关闭此规则。

兼容性

  • JSCS:validateLineBreaks VersionThis规则是在 ESLint 0.21.0.Resources 中引入的
  • 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.handle-callback-err
43.id-blacklist
44.id-length
45.id-match
46.implicit-arrow-linebreak
47.indent
48.indent-legacy
49.init-declarations
50.jsx-quotes
51.key-spacing
52.keyword-spacing
53.line-comment-position
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