lines-around-comment

已棄用

格式化規則現在保留在 eslint-stylistic 中。 @stylistic/ts/lines-around-comment 是此規則的替換。
查看 棄用格式化規則 以取得更多資訊。

需要在註解附近設置空行。

🔧

某些由這個規則回報的問題會自動修正，方法是使用 --fix ESLint 指令行選項.

此規則擴充了基本 eslint/lines-around-comment 規則。它增加了對 TypeScript 語法的支援。

查看 ESLint 文件 以獲得關於 lines-around-comment 規則的更多

如何使用

.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 核心。}