mirror of
https://github.com/Sevichecc/Urara-Blog.git
synced 2025-05-02 03:39:30 +08:00
83 lines
2.4 KiB
Text
83 lines
2.4 KiB
Text
---
|
|
description: 'Require or disallow an empty line between class members.'
|
|
---
|
|
|
|
> 🛑 This file is source code, not the primary documentation location! 🛑
|
|
>
|
|
> See **https://typescript-eslint.io/rules/lines-between-class-members** for documentation.
|
|
|
|
This rule improves readability by enforcing lines between class members. It will not check empty lines before the first member and after the last member. This rule require or disallow an empty line between class members.
|
|
|
|
## Rule Details
|
|
|
|
This rule extends the base [`eslint/lines-between-class-members`](https://eslint.org/docs/rules/lines-between-class-members) rule.
|
|
It adds support for ignoring overload methods in a class.
|
|
|
|
See the [ESLint documentation](https://eslint.org/docs/rules/lines-between-class-members) for more details on the `lines-between-class-members` rule.
|
|
|
|
## Rule Changes
|
|
|
|
```jsonc
|
|
{
|
|
// note you must disable the base rule as it can report incorrect errors
|
|
"lines-between-class-members": "off",
|
|
"@typescript-eslint/lines-between-class-members": ["error"]
|
|
}
|
|
```
|
|
|
|
In addition to the options supported by the `lines-between-class-members` rule in ESLint core, the rule adds the following options:
|
|
|
|
## Options
|
|
|
|
This rule has a string option and an object option.
|
|
|
|
- Object option:
|
|
|
|
- `"exceptAfterOverload": true` (default) - Skip checking empty lines after overload class members
|
|
- `"exceptAfterOverload": false` - **do not** skip checking empty lines after overload class members
|
|
|
|
- [See the other options allowed](https://github.com/eslint/eslint/blob/main/docs/rules/lines-between-class-members.md#options)
|
|
|
|
### `exceptAfterOverload: true`
|
|
|
|
Examples of **correct** code for the `{ "exceptAfterOverload": true }` option:
|
|
|
|
```ts
|
|
/*eslint @typescript-eslint/lines-between-class-members: ["error", "always", { "exceptAfterOverload": true }]*/
|
|
|
|
class foo {
|
|
bar(a: string): void;
|
|
bar(a: string, b: string): void;
|
|
bar(a: string, b: string) {}
|
|
|
|
baz() {}
|
|
|
|
qux() {}
|
|
}
|
|
```
|
|
|
|
### `exceptAfterOverload: false`
|
|
|
|
Examples of **correct** code for the `{ "exceptAfterOverload": false }` option:
|
|
|
|
```ts
|
|
/*eslint @typescript-eslint/lines-between-class-members: ["error", "always", { "exceptAfterOverload": false }]*/
|
|
|
|
class foo {
|
|
bar(a: string): void;
|
|
|
|
bar(a: string, b: string): void;
|
|
|
|
bar(a: string, b: string) {}
|
|
|
|
baz() {}
|
|
|
|
qux() {}
|
|
}
|
|
```
|
|
|
|
<sup>
|
|
|
|
Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/lines-between-class-members.md)
|
|
|
|
</sup>
|