docs/src/rules/newline-after-var.md
As of today there is no consistency in separating variable declarations from the rest of the code. Some developers leave an empty line between var statements and the rest of the code like:
var foo;
// do something with foo
Whereas others don't leave any empty newlines at all.
var foo;
// do something with foo
The problem is when these developers work together in a project. This rule enforces a coding style where empty newlines are allowed or disallowed after var, let, or const statements. It helps the code to look consistent across the entire project.
This rule enforces a coding style where empty lines are required or disallowed after var, let, or const statements to achieve a consistent coding style across the project.
This rule has a string option:
"always" (default) requires an empty line after var, let, or const
Comments on a line directly after var statements are treated like additional var statements.
"never" disallows empty lines after var, let, or const
Examples of incorrect code for this rule with the default "always" option:
::: incorrect
/*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);
:::
Examples of correct code for this rule with the default "always" option:
::: correct
/*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);
:::
Examples of incorrect code for this rule with the "never" option:
::: incorrect
/*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);
:::
Examples of correct code for this rule with the "never" option:
::: correct
/*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);
:::