lines-around-directive

要求或禁止在指令周围出现换行符

🔧

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

重要提示

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

了解更多

指令在 JavaScript 中用于向执行环境表明脚本希望选择加入诸如 "strict mode" 之类的功能。指令在文件或函数块顶部的指令序言中组合在一起，并应用于它们出现的范围。

// Strict mode is invoked for the entire script
"use strict";

var foo;

function bar() {
  var baz;
}
1
2
3
4
5
6
7
8

var foo;

function bar() {
  // Strict mode is only invoked within this function
  "use strict";

  var baz;
}
1
2
3
4
5
6
7
8

规则详情

此规则要求或禁止在指令序言周围出现空白换行符。此规则不强制执行关于各个指令之间空白换行符的任何约定。此外，它不要求在指令序言之前出现空白换行符，除非它们前面有注释。如果您想强制执行这种样式，请使用 padded-blocks 规则。

选项

此规则有一个选项。它可以是字符串或对象

"always"（默认）强制在指令周围使用空白换行符。
"never" 禁止在指令周围使用空白换行符。

或

{
  "before": "always" or "never"
  "after": "always" or "never",
}
1
2
3
4

always

这是默认选项。

对于使用 "always" 选项的此规则，不正确代码的示例

在 Playground 中打开

/* eslint lines-around-directive: ["error", "always"] */

// comment
"use strict";
var foo;

function foo() {
  "use strict";
  "use asm";
  var bar;
}

function foo() {
  // comment
  "use strict";
  var bar;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

在 Playground 中打开

/* eslint lines-around-directive: ["error", "always"] */

// comment
"use strict";
"use asm";
var foo;
1
2
3
4
5
6

对于使用 "always" 选项的此规则，正确代码的示例

在 Playground 中打开

/* eslint lines-around-directive: ["error", "always"] */

// comment

"use strict";

var foo;

function foo() {
  "use strict";
  "use asm";

  var bar;
}

function foo() {
  // comment

  "use strict";

  var bar;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

在 Playground 中打开

/* eslint lines-around-directive: ["error", "always"] */

// comment

"use strict";
"use asm";

var foo;
1
2
3
4
5
6
7
8

never

对于使用 "never" 选项的此规则，不正确代码的示例

在 Playground 中打开

/* eslint lines-around-directive: ["error", "never"] */

// comment

"use strict";

var foo;

function foo() {
  "use strict";
  "use asm";

  var bar;
}

function foo() {
  // comment

  "use strict";

  var bar;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

在 Playground 中打开

/* eslint lines-around-directive: ["error", "never"] */

// comment

"use strict";
"use asm";

var foo;
1
2
3
4
5
6
7
8

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

在 Playground 中打开

/* eslint lines-around-directive: ["error", "never"] */

// comment
"use strict";
var foo;

function foo() {
  "use strict";
  "use asm";
  var bar;
}

function foo() {
  // comment
  "use strict";
  var bar;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

在 Playground 中打开

/* eslint lines-around-directive: ["error", "never"] */

// comment
"use strict";
"use asm";
var foo;
1
2
3
4
5
6

before & after

对于使用 { "before": "never", "after": "always" } 选项的此规则，不正确代码的示例

在 Playground 中打开

/* eslint lines-around-directive: ["error", { "before": "never", "after": "always" }] */

// comment

"use strict";
var foo;

function foo() {
  "use strict";
  "use asm";
  var bar;
}

function foo() {
  // comment

  "use strict";
  var bar;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

在 Playground 中打开

/* eslint lines-around-directive: ["error", { "before": "never", "after": "always" }] */

// comment

"use strict";
"use asm";
var foo;
1
2
3
4
5
6
7

对于使用 { "before": "never", "after": "always" } 选项的此规则，正确代码的示例

在 Playground 中打开

/* eslint lines-around-directive: ["error", { "before": "never", "after": "always" }] */

// comment
"use strict";

var foo;

function foo() {
  "use strict";
  "use asm";

  var bar;
}

function foo() {
  // comment
  "use strict";

  var bar;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

在 Playground 中打开

/* eslint lines-around-directive: ["error", { "before": "never", "after": "always" }] */

// comment
"use strict";
"use asm";

var foo;
1
2
3
4
5
6
7

对于使用 { "before": "always", "after": "never" } 选项的此规则，不正确代码的示例

在 Playground 中打开

/* eslint lines-around-directive: ["error", { "before": "always", "after": "never" }] */

// comment
"use strict";

var foo;

function foo() {
  "use strict";
  "use asm";

  var bar;
}

function foo() {
  // comment
  "use strict";

  var bar;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

在 Playground 中打开

/* eslint lines-around-directive: ["error", { "before": "always", "after": "never" }] */

// comment
"use strict";
"use asm";

var foo;
1
2
3
4
5
6
7

对于使用 { "before": "always", "after": "never" } 选项的此规则，正确代码的示例

在 Playground 中打开

/* eslint lines-around-directive: ["error", { "before": "always", "after": "never" }] */

// comment

"use strict";
var foo;

function foo() {
  "use strict";
  "use asm";
  var bar;
}

function foo() {
  // comment

  "use strict";
  var bar;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

在 Playground 中打开

/* eslint lines-around-directive: ["error", { "before": "always", "after": "never" }] */

// comment

"use strict";
"use asm";
var foo;
1
2
3
4
5
6
7

何时不使用它

如果您对指令序言是否应在其之前或之后具有空白换行符没有任何严格的约定，则可以安全地禁用此规则。

兼容性

JSCS: requirePaddingNewLinesAfterUseStrict
JSCS: disallowPaddingNewLinesAfterUseStrict

版本

此规则在 ESLint v3.5.0 中引入。

资源

编辑此页

lines-around-directive

规则详情

选项

always

never

before & after

何时不使用它

兼容性

相关规则

版本

资源