在线文档教程
Eslint
规则 | Rules

array-element-newline

在数组元素之间强制换行(array-element-newline)

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

许多样式指南要求或不允许数组元素之间的换行符。

规则细节

该规则强制数组元素之间的换行符。

选项

该规则有一个字符串选项:

  • "always" (默认)需要数组元素之间的换行符

  • "never" 不允许数组元素之间的换行符

或者一个对象选项(如果满足任何属性,则需要换行符,否则不允许换行符):

  • "multiline": <boolean>如果元素内有换行符,则需要换行。如果这是错误的,则禁用此条件。

  • "minItems": <number>如果元素的数量至少是给定的整数,则需要换行。如果这是0,这个条件将与选项相同"always"。如果这是null(默认),则禁用此条件。

always

"always"规则的默认代码错误代码示例:

/*eslint array-element-newline: ["error", "always"]*/ var c = [1, 2]; var d = [1, 2, 3]; var e = [ function foo() { dosomething( }, function bar() { dosomething( } ];

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

/*eslint array-element-newline: ["error", "always"]*/ var a = []; var b = [1]; var c = [1, 2]; var d = [1, 2, 3]; var e = [ function foo() { dosomething( }, function bar() { dosomething( } ];

never

"never"规则的默认代码错误代码示例:

/*eslint array-element-newline: ["error", "never"]*/ var c = [ 1, 2 ]; var d = [ 1, 2, 3 ]; var e = [ function foo() { dosomething( }, function bar() { dosomething( } ];

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

/*eslint array-element-newline: ["error", "never"]*/ var a = []; var b = [1]; var c = [1, 2]; var d = [1, 2, 3]; var e = [ function foo() { dosomething( }, function bar() { dosomething( } ];

multiline

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

/*eslint array-element-newline: ["error", { "multiline": true }]*/ var d = [1, 2, 3]; var e = [ function foo() { dosomething( }, function bar() { dosomething( } ];

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

/*eslint array-element-newline: ["error", { "multiline": true }]*/ var a = []; var b = [1]; var c = [1, 2]; var d = [1, 2, 3]; var e = [ function foo() { dosomething( }, function bar() { dosomething( } ];

minItems

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

/*eslint array-element-newline: ["error", { "minItems": 3 }]*/ var c = [1, 2]; var d = [1, 2, 3]; var e = [ function foo() { dosomething( }, function bar() { dosomething( } ];

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

/*eslint array-element-newline: ["error", { "minItems": 3 }]*/ var a = []; var b = [1]; var c = [1, 2]; var d = [1, 2, 3]; var e = [ function foo() { dosomething( }, function bar() { dosomething( } ];

multiline and minItems

{ "multiline": true, "minItems": 3 }规则的错误代码示例如下:

/*eslint array-element-newline: ["error", { "multiline": true, "minItems": 3 }]*/ var c = [1, 2]; var d = [1, 2, 3]; var e = [ function foo() { dosomething( }, function bar() { dosomething( } ];

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

/*eslint array-element-newline: ["error", { "multiline": true, "minItems": 3 }]*/ var a = []; var b = [1]; var c = [1, 2]; var d = [1, 2, 3]; var e = [ function foo() { dosomething( }, function bar() { dosomething( } ];

何时不使用它

如果您不想在数组元素之间强制换行,请不要启用此规则。

兼容性

  • JSCS: validateNewlineAfterArrayElements相关规则

  • array-bracket-spacing

  • array-bracket-newline

  • object-property-newline

  • object-curly-spacing

  • object-curly-newline

  • max-statements-per-line

  • block-spacing

  • brace-style

版本

该规则在ESLint 4.0.0-rc.0中引入。

资源