Skip to content

Commit

Permalink
docs(eslint-plugin): [lines-around-comment option] cleaned up docs (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaKGoldberg committed Mar 20, 2023
1 parent 33979c8 commit 75eb5b5
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions packages/eslint-plugin/docs/rules/lines-around-comment.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,15 @@ See the [ESLint documentation](https://eslint.org/docs/rules/lines-around-commen
}
```

In addition to the options supported by the `lines-around-comment` rule in ESLint core, the rule adds the following options:

## Options

- `allowInterfaceStart: true` doesn't require a blank line after the interface body block start
- `allowInterfaceEnd: true` doesn't require a blank line before the interface body block end
- `allowTypeStart: true` doesn't require a blank line after the type literal block start
- `allowTypeEnd: true` doesn't require a blank line after the type literal block end

[See the other options allowed](https://eslint.org/docs/rules/comma-dangle#options)

<sup>

Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/lines-around-comment.md)
In addition to the options supported by the `lines-around-comment` rule in ESLint core, the rule adds the following options:

</sup>
- `allowEnumEnd: true` doesn't require a blank line after an interface body block end
- `allowEnumStart: true` doesn't require a blank line before an interface body block start
- `allowInterfaceEnd: true` doesn't require a blank line before an interface body block end
- `allowInterfaceStart: true` doesn't require a blank line after an interface body block start
- `allowModuleEnd: true` doesn't require a blank line before a module body block end
- `allowModuleStart: true` doesn't require a blank line after a module body block start
- `allowTypeEnd: true` doesn't require a blank line before a type literal block end
- `allowTypeStart: true` doesn't require a blank line after a type literal block start

0 comments on commit 75eb5b5

Please sign in to comment.