Skip to main content

lines-around-comment

danger
We strongly recommend you do not use this rule or any other formatting linter rules. Use a separate dedicated formatter instead. See What About Formatting? for more information.

Require empty lines around comments.

🔧

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

Rule Details​

This rule extends the base eslint/lines-around-comment rule. It adds support for TypeScript syntax.

See the ESLint documentation for more details on the comma-dangle rule.

Rule Changes​

{
  // note you must disable the base rule as it can report incorrect errors
  "lines-around-comment": "off",
  "@typescript-eslint/lines-around-comment": ["error"]
}

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

How to Use​

.eslintrc.cjs
module.exports = {
  "rules": {
    // Note: you must disable the base rule as it can report incorrect errors
    "lines-around-comment": "off",
    "@typescript-eslint/lines-around-comment": "error"
  }
};
Try this rule in the playground ↗

Options​

See eslint/lines-around-comment 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

Taken with ❤️ from ESLint core

Resources​

Taken with ❤️ from ESLint core