Skip to content

Commit

Permalink
New: lines-around-directive rule (fixes #6069)
Browse files Browse the repository at this point in the history
  • Loading branch information
kaicataldo committed Aug 28, 2016
1 parent 6869c60 commit 0181e56
Show file tree
Hide file tree
Showing 4 changed files with 1,333 additions and 0 deletions.
1 change: 1 addition & 0 deletions conf/eslint.json
Expand Up @@ -172,6 +172,7 @@
"keyword-spacing": "off",
"linebreak-style": "off",
"lines-around-comment": "off",
"lines-around-directive": "off",
"max-depth": "off",
"max-len": "off",
"max-lines": "off",
Expand Down
302 changes: 302 additions & 0 deletions docs/rules/lines-around-directive.md
@@ -0,0 +1,302 @@
# enforce or disallow newlines around directives (lines-around-directive)

The `"strict mode";` directive is used in JavaScript to invoke strict mode. It must occur either at the top of a file or function block and is applied to the scope in which it occurs.

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

var foo;

function bar() {
var baz;
}
```

```js
var foo;

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

var baz;
}
```

## Rule Details

This rule enforces or disallows blank newlines around directives.
Note: It does not enforce blank newlines before directives 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.

```json
{
"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";
var foo;

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

function foo() {
// comment
"use strict";
var foo;
}
```

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";

var foo;

function foo() {
"use strict";

var foo;
}

function foo() {
// comment

"use strict";

var foo;
}
```

### 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";

var foo;


function foo() {
"use strict";

var foo;
}


function foo() {
// comment

"use strict";

var foo;
}
```

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";
var foo;

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

function foo() {
// comment
"use strict";
var foo;
}
```

### 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";
var foo;

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

function foo() {
// comment

"use strict";
var foo;
}
```

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";

var foo;

function foo() {
"use strict";

var foo;
}

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

var foo;
}
```

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";

var foo;

function foo() {
"use strict";

var foo;
}

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

var foo;
}
```

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";
var foo;

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

function foo() {
// comment

"use strict";
var foo;
}
```

## When Not To Use It

You can safely disable this rule if you do not have any strict conventions about whether or not directives 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)

0 comments on commit 0181e56

Please sign in to comment.