Skip to main content

lines-between-class-members

Deprecated

Formatting rules now live in eslint-stylistic. @stylistic/ts/lines-between-class-members is the replacement for this rule.
See Deprecating Formatting Rules for more information.

Require or disallow an empty line between class members.

🔧

Some problems reported by this rule are automatically fixable by the --fix ESLint command line option.

This rule extends the base eslint/lines-between-class-members rule. It adds support for ignoring overload methods in a class.

How to Use​

.eslintrc.cjs
module.exports = {
  "rules": {
    // 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"
  }
};

Try this rule in the playground ↗

Options​

See eslint/lines-between-class-members options.

In addition to the options supported by the lines-between-class-members rule in ESLint core, the rule adds the following options:

  • 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

exceptAfterOverload: true​

Examples of correct code for the { "exceptAfterOverload": true } option:

class foo {
  bar(a: string): void;
  bar(a: string, b: string): void;
  bar(a: string, b: string) {}

  baz() {}

  qux() {}
}
Open in Playground

exceptAfterOverload: false​

Examples of correct code for the { "exceptAfterOverload": false } option:

class foo {
  bar(a: string): void;

  bar(a: string, b: string): void;

  bar(a: string, b: string) {}

  baz() {}

  qux() {}
}
Open in Playground

Resources​

Taken with ❤️ from ESLint core.