From 0e8cf5365c36fb62be11ecf2bf3550dff24087c2 Mon Sep 17 00:00:00 2001 From: Arthur Dias Date: Fri, 5 Jun 2020 13:48:02 -0300 Subject: [PATCH] Docs: On maxEOF with eol-last (fixes #12742) Added an explanation on how and why maxEOF should be set to 0 to work with the eol-last rule. --- docs/rules/no-multiple-empty-lines.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/docs/rules/no-multiple-empty-lines.md b/docs/rules/no-multiple-empty-lines.md index 1d9006b89be..836cb18e471 100644 --- a/docs/rules/no-multiple-empty-lines.md +++ b/docs/rules/no-multiple-empty-lines.md @@ -10,9 +10,9 @@ This rule aims to reduce the scrolling required when reading through your code. This rule has an object option: -* `"max"` (default: `2`) enforces a maximum number of consecutive empty lines. -* `"maxEOF"` enforces a maximum number of consecutive empty lines at the end of files. -* `"maxBOF"` enforces a maximum number of consecutive empty lines at the beginning of files. +- `"max"` (default: `2`) enforces a maximum number of consecutive empty lines. +- `"maxEOF"` enforces a maximum number of consecutive empty lines at the end of files. +- `"maxBOF"` enforces a maximum number of consecutive empty lines at the beginning of files. ### max @@ -23,8 +23,6 @@ Examples of **incorrect** code for this rule with the default `{ "max": 2 }` opt var foo = 5; - - var bar = 3; ``` @@ -35,7 +33,6 @@ Examples of **correct** code for this rule with the default `{ "max": 2 }` optio var foo = 5; - var bar = 3; ``` @@ -48,10 +45,7 @@ Examples of **incorrect** code for this rule with the `{ max: 2, maxEOF: 0 }` op var foo = 5; - var bar = 3; - - ``` Examples of **correct** code for this rule with the `{ max: 2, maxEOF: 0 }` options: @@ -61,12 +55,10 @@ Examples of **correct** code for this rule with the `{ max: 2, maxEOF: 0 }` opti var foo = 5; - var bar = 3; ``` -**Note**: Although this ensures zero empty lines at the EOF, most editors will still show one empty line at the end, as illustrated below. There is no empty line at the end of a file after the last `\n`, although editors may show an additional line. A true additional line would be represented by `\n\n`. - +**Note**: Although this ensures zero empty lines at the EOF, most editors will still show one empty line at the end if the file ends with a line break, as illustrated below. There is no empty line at the end of a file after the last `\n`, although editors may show an additional line. A true additional line would be represented by `\n\n`. **Incorrect**: @@ -100,10 +92,8 @@ Examples of **incorrect** code for this rule with the `{ max: 2, maxBOF: 1 }` op ```js /*eslint no-multiple-empty-lines: ["error", { "max": 2, "maxBOF": 1 }]*/ - var foo = 5; - var bar = 3; ``` @@ -114,7 +104,6 @@ Examples of **correct** code for this rule with the `{ max: 2, maxBOF: 1 }` opti var foo = 5; - var bar = 3; ```