newline-after-var

要求或禁止在变量声明后出现空行

🔧

此规则报告的一些问题可以通过 --fix 命令行选项自动修复

重要提示

此规则在 ESLint v4.0.0 中已弃用。请使用 @stylistic/eslint-plugin-js 中相应的规则。

了解更多

截至今日，在将变量声明与代码其余部分分离方面没有一致性。一些开发人员在 var 语句和代码其余部分之间留空行，例如

var foo;

// do something with foo
1
2
3

而另一些开发人员则完全不留任何空行。

var foo;
// do something with foo
1
2

问题在于当这些开发人员在同一个项目中一起工作时。此规则强制执行一种编码风格，其中在 var、let 或 const 语句之后允许或禁止空行。这有助于使整个项目中的代码看起来一致。

规则详情

此规则强制执行一种编码风格，其中在 var、let 或 const 语句之后要求或禁止空行，以实现整个项目中的一致编码风格。

选项

此规则有一个字符串选项

"always"（默认）要求在 var、let 或 const 之后有一个空行

直接在 var 语句后一行的注释被视为额外的 var 语句。
"never" 禁止在 var、let 或 const 之后出现空行

always

使用默认 "always" 选项时此规则的错误代码示例

在 Playground 中打开

/*eslint newline-after-var: ["error", "always"]*/

var greet = "hello,",
    name = "world";
console.log(greet, name);

let hello = "hello,",
    world = "world";
console.log(hello, world);

var greet = "hello,";
const NAME = "world";
console.log(greet, NAME);

var greet = "hello,";
var name = "world";
// var name = require("world");
console.log(greet, name);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

使用默认 "always" 选项时此规则的正确代码示例

在 Playground 中打开

/*eslint newline-after-var: ["error", "always"]*/

var greet = "hello,",
    name = "world";

console.log(greet, name);

let hello = "hello,",
    world = "world";

console.log(hello, world);

var greet = "hello,";
const NAME = "world";

console.log(greet, NAME);

var greet = "hello,";
var name = "world";
// var name = require("world");

console.log(greet, name);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

never

使用 "never" 选项时此规则的错误代码示例

在 Playground 中打开

/*eslint newline-after-var: ["error", "never"]*/

var greet = "hello,",
    name = "world";

console.log(greet, name);

let hello = "hello,",
    world = "world";

console.log(hello, world);

var greet = "hello,";
const NAME = "world";

console.log(greet, NAME);

var greet = "hello,";
var name = "world";
// var name = require("world");

console.log(greet, name);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

使用 "never" 选项时此规则的正确代码示例

在 Playground 中打开

/*eslint newline-after-var: ["error", "never"]*/

var greet = "hello,",
    name = "world";
console.log(greet, name);

let hello = "hello,",
    world = "world";
console.log(hello, world);

var greet = "hello,";
const NAME = "world";
console.log(greet, NAME);

var greet = "hello,";
var name = "world";
// var name = require("world");
console.log(greet, name);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

版本

此规则在 ESLint v0.18.0 中引入。

资源

编辑此页面