ルールの抑制

歴史的な status 値を madr/status-enum が拒否するなど、レガシーな ADR が 1 つだけ正当にルールへ違反することがあります。その 1 ファイルのためにルールをプロジェクト全体で off にするのは割に合いません。インライン抑制コメントは、ESLint の eslint-disable コメントと同じように、ファイル単位・行単位のエスケープハッチを提供します。

ディレクティブは ADR の Markdown 本文に書く通常の HTML コメントです。ルールからは一切見えません — 抑制はすべてのルールが報告を終えた後に、中央でまとめて適用されます。

4 つのディレクティブ

<!-- madr-lint-disable-file -->
このファイル内のすべてを抑制します。

<!-- madr-lint-disable -->
この行からファイル末尾まで、または対応する
madr-lint-enable まで抑制します。

<!-- madr-lint-enable -->
以前に無効化したルールを再度有効にします。

<!-- madr-lint-disable-next-line -->
次の（空行でない）行だけを抑制します。

特定のルールへのスコープ

各形式は、完全なルール ID のカンマ区切りリストを任意で受け取ります。リストがない場合、ディレクティブはすべてのルールに適用されます。

<!-- madr-lint-disable-next-line madr/status-enum -->
- Status: superseded-but-we-spelled-it-oddly

<!-- madr-lint-disable madr/status-enum, madr/date-iso8601 -->
…ここから両方のルールが抑制される…
<!-- madr-lint-enable madr/date-iso8601 -->
…以降は madr/status-enum のみ抑制されたまま…

enable は名指ししたもの（スコープなしの場合はすべて）を再有効化します。つまりスコープなしの disable の後にスコープ付きの enable を書くと、それ以外は無効化されたままになります — ESLint のセマンティクスと同じです。

`disable-next-line` は次の空行でない行を対象にする

ESLint と異なり、madr-lint-disable-next-line は文字どおりの次の行ではなく、次の 空行でない行に適用されます。Markdown の書き手はコメントブロックの後に空行を置くのが慣例であり、それを越えられずに黙って外れるディレクティブは罠になるためです。次のどちらも機能します。

<!-- madr-lint-disable-next-line madr/no-broken-links -->
[アーカイブされた設計文書](./2019-design.md)

<!-- madr-lint-disable-next-line madr/no-broken-links -->

[アーカイブされた設計文書](./2019-design.md)

プロジェクト（ファイル間）ルール

プロジェクトルール（例: madr/no-duplicate-numbering）の診断は特定のファイルに帰属します。そのファイル内のディレクティブがそれらを抑制します。

ファイルスコープの抑制 — disable-file、または後続の対応する enable を持たない disable — は、そのファイルのプロジェクト診断を抑制します。
行スコープの抑制（disable-next-line、disable/enable の範囲）は、 madr/no-broken-links の診断のように、診断が行番号を持つ場合に適用されます。

制限事項と注意点

フロントマターは行単位で対象にできません。 YAML フロントマターは Markdown 本文のパース前に取り除かれるため、フロントマターの値（例: フロントマターの status:）に関する診断は行番号を持ちません。行スコープのディレクティブでは届かないので、代わりにそのルールに対するファイルスコープの disable を使ってください。MADR v2 のメタデータリストの値は本文にあるため、行単位で対象に できます。
行番号を持たない診断（例: madr/filename-format、セクションの欠落、メタデータフィールドの欠落）は、ファイルスコープの抑制 — disable-file、またはファイル末尾まで開いたままの disable — でのみ抑制されます。 disable/enable で閉じた範囲では抑制されません。
1 コメントにつき 1 ディレクティブ、単独で書くこと。 同じ行に別のコメントを含むコメント（）はディレクティブとして拒否されます。未知のキーワード（例: madr-lint-disable-line）や通常の HTML コメントは黙って無視されます。
disable-next-line コメントを 2 つ重ねても連鎖しません。 1 つ目は 2 つ目のコメントの行を対象にしてしまい、本来の内容には届きません — 代わりに 1 つのコメント内にカンマ区切りでルールをまとめて書いてください。
core/internal-error は抑制できません。 これは ADR に関する指摘ではなく、ルールのバグを知らせるものです。
キャッシュは正しく保たれます。 ディレクティブはファイル内容の一部なので、追加・削除するとコンテンツハッシュのキャッシュは自動的に無効化されます。

系統的な例外には設定を使う

多くのファイルで同じルールを抑制していると気づいたら、インラインディレクティブではなく設定ファイルでルールのオプションや重大度を変更してください — インラインディレクティブは 1 回限りの例外のためのもので、ポリシーのためのものではありません。