非常教程

Eslint参考手册

规则 | Rules

max-lines

有些人认为大文件代码味道。大文件往往会做很多事情,并且可能会让事情变得很难。虽然在文件中没有客观的最大数量的线被认为是可以接受的,但大多数人会认为它不应该是成千上万。建议通常范围从100到500行。

Rule Details

此规则为每个文件强制执行最多行数,以帮助维护和降低复杂性。

Options

此规则有一个数字或对象选项:

  • "max"(默认300)在文件中强制执行最大行数
  • "skipBlankLines": true 忽略纯粹由空白组成的线条。
  • "skipComments": true 忽略仅包含评论的行

code

此规则的错误代码示例,最大值为2

/*eslint max-lines: ["error", 2]*/
var a,
    b,
    c;
/*eslint max-lines: ["error", 2]*/

var a,
    b,c;
/*eslint max-lines: ["error", 2]*/
// a comment
var a,
    b,c;

此规则的正确代码示例,最大值为2

/*eslint max-lines: ["error", 2]*/
var a,
    b, c;
/*eslint max-lines: ["error", 2]*/

var a, b, c;
/*eslint max-lines: ["error", 2]*/
// a comment
var a, b, c;

skipBlankLines

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

/*eslint max-lines: ["error", {"max": 2, "skipBlankLines": true}]*/

var a,
    b,
    c;

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

/*eslint max-lines: ["error", {"max": 2, "skipBlankLines": true}]*/

var a,
    b, c;

skipComments

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

/*eslint max-lines: ["error", {"max": 2, "skipComments": true}]*/
// a comment
var a,
    b,
    c;

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

/*eslint max-lines: ["error", {"max": 2, "skipComments": true}]*/
// a comment
var a,
    b, c;

何时不使用它

如果您不关心文件中的行数,则可以关闭此规则。

进一步阅读

  • Software Module size and file size

相关规则

  • complexity
  • max-depth
  • max-nested-callbacks
  • max-params
  • max-statements

兼容性

  • JSCS: maximumNumberOfLines

版本

该规则在ESLint 2.12.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.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.linebreak-style
55.lines-around-comment
56.lines-around-directive
57.lines-between-class-members
58.max-depth
59.max-len
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