lines-around-comment

已弃用

格式规则现在位于 eslint-stylistic 中。 @stylistic/ts/lines-around-comment 是此规则的替代品。
有关更多信息，请参阅 弃用格式规则。

要求注释周围有空行。

🔧

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

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

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

如何使用

.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 核心中的 lines-around-comment 规则支持的选项外，该规则还添加了以下选项

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

资源

• 规则源代码
• 测试源代码

^{来自 ESLint 核心 的 ❤️。}