29 lines
1.4 KiB
Plaintext
29 lines
1.4 KiB
Plaintext
---
|
|
description: 'Require empty lines around comments.'
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
> 🛑 This file is source code, not the primary documentation location! 🛑
|
|
>
|
|
> See **https://typescript-eslint.io/rules/lines-around-comment** for documentation.
|
|
|
|
This rule extends the base [`eslint/lines-around-comment`](https://eslint.org/docs/rules/lines-around-comment) rule.
|
|
It adds support for TypeScript syntax.
|
|
|
|
See the [ESLint documentation](https://eslint.org/docs/rules/lines-around-comment) for more details on the `lines-around-comment` rule.
|
|
|
|
## Options
|
|
|
|
In addition to the options supported by the `lines-around-comment` rule in ESLint core, the rule adds the following options:
|
|
|
|
- `allowEnumEnd: true` doesn't require a blank line after an enum body block end
|
|
- `allowEnumStart: true` doesn't require a blank line before an enum 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
|