lines-around-directive

要求或禁止指令周圍有換行符

🔧

此規則報告的某些問題可以透過 --fix 命令列選項自動修正

此規則在 ESLint v4.0.0 中已棄用，並由 padding-line-between-statements 規則取代。

指令在 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" 選項時，此規則的不正確程式碼範例

在線上編輯器中開啟

/* 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

在線上編輯器中開啟

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

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

使用 "always" 選項時，此規則的正確程式碼範例

在線上編輯器中開啟

/* 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

在線上編輯器中開啟

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

// comment

"use strict";
"use asm";

var foo;
1
2
3
4
5
6
7
8

never

使用 "never" 選項時，此規則的不正確程式碼範例

在線上編輯器中開啟

/* 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

在線上編輯器中開啟

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

// comment

"use strict";
"use asm";

var foo;
1
2
3
4
5
6
7
8

使用 "never" 選項時，此規則的正確程式碼範例

在線上編輯器中開啟

/* 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

在線上編輯器中開啟

/* 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" } 選項時，此規則的不正確程式碼範例

在線上編輯器中開啟

/* 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

在線上編輯器中開啟

/* 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" } 選項時，此規則的正確程式碼範例

在線上編輯器中開啟

/* 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

在線上編輯器中開啟

/* 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" } 選項時，此規則的不正確程式碼範例

在線上編輯器中開啟

/* 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

在線上編輯器中開啟

/* 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" } 選項時，此規則的正確程式碼範例

在線上編輯器中開啟

/* 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

在線上編輯器中開啟

/* 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

何時不使用

相容性

相關規則

版本

資源