Skip to main content

lines-around-comment

danger
This rule will soon be moved to eslint-stylistic. See What About Formatting? for more information.

Require empty lines around comments.

🔧

此规则报告的一些问题可通过 --fix ESLint 命令行选项自动修复。


此规则扩展了基本 eslint/lines-around-comment 规则。 它添加了对 TypeScript 语法的支持。

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

有关 lines-around-comment 规则的更多详细信息，请参阅 ESLint 文档。

英：See the ESLint documentation for more details on the lines-around-comment rule.

选项​

除了 ESLint 核心中 lines-around-comment 规则支持的选项外，该规则还添加了以下选项：

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

  • allowEnumEnd: true 在枚举主体块结束后不需要空行
  • allowEnumStart: true 在枚举主体块开始之前不需要空行
  • allowInterfaceEnd: true 接口主体块结束前不需要空行
  • allowInterfaceStart: true 接口主体块开始后不需要空行
  • allowModuleEnd: true 在模块主体块结束之前不需要空行
  • allowModuleStart: true 在模块主体块开始后不需要空行
  • allowTypeEnd: true 在类型字面量块结束之前不需要空行
  • allowTypeStart: true 在类型字面量块开始后不需要空行

如何使用​

.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"
  }
};
在线运行试试这个规则 ↗

选项​

参见 eslint/lines-around-comment 选项。

资源​

摘自 ❤️ ESLint 内核