pve-eslint/eslint/docs/rules/one-var-declaration-per-line.md
Dominik Csapak eb39fafa4f first commit
includes a (minimal) working wrapper

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2020-04-06 15:06:03 +02:00

90 lines
1.6 KiB
Markdown

# require or disallow newlines around variable declarations (one-var-declaration-per-line)
Some developers declare multiple var statements on the same line:
```js
var foo, bar, baz;
```
Others prefer to declare one var per line.
```js
var foo,
bar,
baz;
```
Keeping to one of these styles across a project's codebase can help with maintaining code consistency.
## Rule Details
This rule enforces a consistent newlines around variable declarations. This rule ignores variable declarations inside `for` loop conditionals.
## Options
This rule has a single string option:
* `"initializations"` (default) enforces a newline around variable initializations
* `"always"` enforces a newline around variable declarations
### initializations
Examples of **incorrect** code for this rule with the default `"initializations"` option:
```js
/*eslint one-var-declaration-per-line: ["error", "initializations"]*/
/*eslint-env es6*/
var a, b, c = 0;
let a,
b = 0, c;
```
Examples of **correct** code for this rule with the default `"initializations"` option:
```js
/*eslint one-var-declaration-per-line: ["error", "initializations"]*/
/*eslint-env es6*/
var a, b;
let a,
b;
let a,
b = 0;
```
### always
Examples of **incorrect** code for this rule with the `"always"` option:
```js
/*eslint one-var-declaration-per-line: ["error", "always"]*/
/*eslint-env es6*/
var a, b;
let a, b = 0;
const a = 0, b = 0;
```
Examples of **correct** code for this rule with the `"always"` option:
```js
/*eslint one-var-declaration-per-line: ["error", "always"]*/
/*eslint-env es6*/
var a,
b;
let a,
b = 0;
```
## Related Rules
* [one-var](one-var.md)