Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
1 parent
61f1de0
commit c1f0d76
Showing
6 changed files
with
2,096 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,320 @@ | ||
# require or disallow newlines around directives (lines-around-directive) | ||
|
||
Directives are used in JavaScript to indicate to the execution environment that a script would like to opt into a feature such as `"strict mode"`. Directives are grouped together in a [directive prologue](http://www.ecma-international.org/ecma-262/7.0/#directive-prologue) at the top of either a file or function block and are applied to the scope in which they occur. | ||
|
||
```js | ||
// Strict mode is invoked for the entire script | ||
"use strict"; | ||
|
||
var foo; | ||
|
||
function bar() { | ||
var baz; | ||
} | ||
``` | ||
|
||
```js | ||
var foo; | ||
|
||
function bar() { | ||
// Strict mode is only invoked within this function | ||
"use strict"; | ||
|
||
var baz; | ||
} | ||
``` | ||
|
||
## Rule Details | ||
|
||
This rule requires or disallows blank newlines around directive prologues. This rule does not enforce any conventions about blank newlines between the individual directives. In addition, it does not require blank newlines before directive prologues unless they are preceded by a comment. Please use the [padded-blocks](padded-blocks.md) rule if this is a style you would like to enforce. | ||
|
||
## Options | ||
|
||
This rule has one option. It can either be a string or an object: | ||
|
||
* `"always"` (default) enforces blank newlines around directives. | ||
* `"never"` disallows blank newlines around directives. | ||
|
||
or | ||
|
||
```js | ||
{ | ||
"before": "always" or "never" | ||
"after": "always" or "never", | ||
} | ||
``` | ||
|
||
### always | ||
|
||
This is the default option. | ||
|
||
Examples of **incorrect** code for this rule with the `"always"` option: | ||
|
||
```js | ||
/* eslint lines-around-directive: ["error", "always"] */ | ||
|
||
/* Top of file */ | ||
"use strict"; | ||
var foo; | ||
|
||
/* Top of file */ | ||
// comment | ||
"use strict"; | ||
"use asm"; | ||
var foo; | ||
|
||
function foo() { | ||
"use strict"; | ||
"use asm"; | ||
var bar; | ||
} | ||
|
||
function foo() { | ||
// comment | ||
"use strict"; | ||
var bar; | ||
} | ||
``` | ||
|
||
Examples of **correct** code for this rule with the `"always"` option: | ||
|
||
```js | ||
/* eslint lines-around-directive: ["error", "always"] */ | ||
|
||
/* Top of file */ | ||
"use strict"; | ||
|
||
var foo; | ||
|
||
/* Top of file */ | ||
// comment | ||
|
||
"use strict"; | ||
"use asm"; | ||
|
||
var foo; | ||
|
||
function foo() { | ||
"use strict"; | ||
"use asm"; | ||
|
||
var bar; | ||
} | ||
|
||
function foo() { | ||
// comment | ||
|
||
"use strict"; | ||
|
||
var bar; | ||
} | ||
``` | ||
|
||
### never | ||
|
||
Examples of **incorrect** code for this rule with the `"never"` option: | ||
|
||
```js | ||
/* eslint lines-around-directive: ["error", "never"] */ | ||
|
||
/* Top of file */ | ||
|
||
"use strict"; | ||
|
||
var foo; | ||
|
||
|
||
/* Top of file */ | ||
// comment | ||
|
||
"use strict"; | ||
"use asm"; | ||
|
||
var foo; | ||
|
||
|
||
function foo() { | ||
"use strict"; | ||
"use asm"; | ||
|
||
var bar; | ||
} | ||
|
||
|
||
function foo() { | ||
// comment | ||
|
||
"use strict"; | ||
|
||
var bar; | ||
} | ||
``` | ||
|
||
Examples of **correct** code for this rule with the `"never"` option: | ||
|
||
```js | ||
/* eslint lines-around-directive: ["error", "never"] */ | ||
|
||
/* Top of file */ | ||
"use strict"; | ||
var foo; | ||
|
||
/* Top of file */ | ||
// comment | ||
"use strict"; | ||
"use asm"; | ||
var foo; | ||
|
||
function foo() { | ||
"use strict"; | ||
"use asm"; | ||
var bar; | ||
} | ||
|
||
function foo() { | ||
// comment | ||
"use strict"; | ||
var bar; | ||
} | ||
``` | ||
|
||
### before & after | ||
|
||
Examples of **incorrect** code for this rule with the `{ "before": "never", "after": "always" }` option: | ||
|
||
```js | ||
/* eslint lines-around-directive: ["error", { "before": "never", "after": "always" }] */ | ||
|
||
/* Top of file */ | ||
|
||
"use strict"; | ||
var foo; | ||
|
||
/* Top of file */ | ||
// comment | ||
|
||
"use strict"; | ||
"use asm"; | ||
var foo; | ||
|
||
function foo() { | ||
"use strict"; | ||
"use asm"; | ||
var bar; | ||
} | ||
|
||
function foo() { | ||
// comment | ||
|
||
"use strict"; | ||
var bar; | ||
} | ||
``` | ||
|
||
Examples of **correct** code for this rule with the `{ "before": "never", "after": "always" }` option: | ||
|
||
```js | ||
/* eslint lines-around-directive: ["error", { "before": "never", "after": "always" }] */ | ||
|
||
/* Top of file */ | ||
"use strict"; | ||
|
||
var foo; | ||
|
||
/* Top of file */ | ||
// comment | ||
"use strict"; | ||
"use asm"; | ||
|
||
var foo; | ||
|
||
function foo() { | ||
"use strict"; | ||
"use asm"; | ||
|
||
var bar; | ||
} | ||
|
||
function foo() { | ||
// comment | ||
"use strict"; | ||
|
||
var bar; | ||
} | ||
``` | ||
|
||
Examples of **incorrect** code for this rule with the `{ "before": "always", "after": "never" }` option: | ||
|
||
```js | ||
/* eslint lines-around-directive: ["error", { "before": "always", "after": "never" }] */ | ||
|
||
/* Top of file */ | ||
"use strict"; | ||
|
||
var foo; | ||
|
||
/* Top of file */ | ||
// comment | ||
"use strict"; | ||
"use asm"; | ||
|
||
var foo; | ||
|
||
function foo() { | ||
"use strict"; | ||
"use asm"; | ||
|
||
var bar; | ||
} | ||
|
||
function foo() { | ||
// comment | ||
"use strict"; | ||
|
||
var bar; | ||
} | ||
``` | ||
|
||
Examples of **correct** code for this rule with the `{ "before": "always", "after": "never" }` option: | ||
|
||
```js | ||
/* eslint lines-around-directive: ["error", { "before": "always", "after": "never" }] */ | ||
|
||
/* Top of file */ | ||
"use strict"; | ||
var foo; | ||
|
||
/* Top of file */ | ||
// comment | ||
|
||
"use strict"; | ||
"use asm"; | ||
var foo; | ||
|
||
function foo() { | ||
"use strict"; | ||
"use asm"; | ||
var bar; | ||
} | ||
|
||
function foo() { | ||
// comment | ||
|
||
"use strict"; | ||
var bar; | ||
} | ||
``` | ||
|
||
## When Not To Use It | ||
|
||
You can safely disable this rule if you do not have any strict conventions about whether or not directive prologues should have blank newlines before or after them. | ||
|
||
## Related Rules | ||
|
||
* [lines-around-comment](lines-around-comment.md) | ||
* [padded-blocks](padded-blocks.md) | ||
|
||
## Compatibility | ||
|
||
* **JSCS**: [requirePaddingNewLinesAfterUseStrict](http://jscs.info/rule/requirePaddingNewLinesAfterUseStrict) | ||
* **JSCS**: [disallowPaddingNewLinesAfterUseStrict](http://jscs.info/rule/disallowPaddingNewLinesAfterUseStrict) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.