メインコンテンツへスキップ

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"
  }
};

このルールをPlaygroundでお試しください ↗

オプション​

eslint/lines-around-commentのオプションを参照してください。

ESLintコアのlines-around-commentルールでサポートされているオプションに加えて、次のオプションが追加されています。

  • allowEnumEnd: true は、enum本体ブロックの終端後に空行を要求しません。
  • allowEnumStart: true は、enum本体ブロックの開始前に空行を要求しません。
  • allowInterfaceEnd: true は、インターフェース本体ブロックの終端前に空行を要求しません。
  • allowInterfaceStart: true は、インターフェース本体ブロックの開始後に空行を要求しません。
  • allowModuleEnd: true は、モジュール本体ブロックの終端前に空行を要求しません。
  • allowModuleStart: true は、モジュール本体ブロックの開始後に空行を要求しません。
  • allowTypeEnd: true は、型リテラルブロックの終端前に空行を要求しません。
  • allowTypeStart: true は、型リテラルブロックの開始後に空行を要求しません。

リソース​

ESLintコアから❤️を込めて取得しました。