NOTE 111 / 2022年
検査のルールを、現場の事情に合わせる
markuplint を導入するときに、ルールをどう育てるかを整理します。
読了目安 約2分
markuplint は HTML の構造を検査するツールですが、初期状態のルールをそのまま使うと、既存のコードで大量の警告が出ることがあります。まずは重大な問題に絞り、プロジェクトの事情に合わせてルールを調整するのが現実的です。
ルールを緩める場合でも、なぜ緩めたのかを設定ファイルに残しておくと、後から参加した人が判断の理由をたどれます。CI で実行する場合は、対象ファイルと除外範囲も一緒に決めておきましょう。
押さえたい点
- 01最初から全ルールを有効にしない
- 02除外した理由を設定に残す
- 03CI の対象範囲を明示する
参考資料
外部サイトが開きます。内容は各サイトの管理下にあります。
- MDN アクセシビリティ 外部サイトdeveloper.mozilla.org
- W3C WAI 外部サイトw3.org
- WAI ARIA APG 外部サイトw3.org
- WAI チュートリアル 外部サイトw3.org
- web.dev アクセシビリティ 外部サイトweb.dev
- アクセシビリティを学ぶ 外部サイトweb.dev
- WCAG 2.1 外部サイトw3.org
- WCAG 2.2 外部サイトw3.org
- ARIA in HTML 外部サイトw3.org
- MDN ARIA 外部サイトdeveloper.mozilla.org
- React 学習ガイド 外部サイトreact.dev
- React リファレンス 外部サイトreact.dev
- React で考える 外部サイトreact.dev