本文へ
NOTE 111 / 2022年

検査のルールを、現場の事情に合わせる

markuplint を導入するときに、ルールをどう育てるかを整理します。

読了目安 約2分

markuplint は HTML の構造を検査するツールですが、初期状態のルールをそのまま使うと、既存のコードで大量の警告が出ることがあります。まずは重大な問題に絞り、プロジェクトの事情に合わせてルールを調整するのが現実的です。

ルールを緩める場合でも、なぜ緩めたのかを設定ファイルに残しておくと、後から参加した人が判断の理由をたどれます。CI で実行する場合は、対象ファイルと除外範囲も一緒に決めておきましょう。

押さえたい点

  1. 01最初から全ルールを有効にしない
  2. 02除外した理由を設定に残す
  3. 03CI の対象範囲を明示する

参考資料

外部サイトが開きます。内容は各サイトの管理下にあります。

関連するノート

ページの先頭へ