Markdown用静的解析ツール
markdownlintは、Markdownファイルに対して静的解析(lint)を行うnpmパッケージです。コードの品質や一貫性を保つためのルールベースのチェック機能を提供し、CI/CDパイプラインにも組み込める柔軟な設定が可能です。
背景メモ
- **markdownlint** は、Markdown ファイルに対してコードのスタイルや構文の問題を自動チェックする静的解析ツール(リンター)。ESLint や RuboCop の Markdown 版にあたる。
- **David Anson**(Microsoft のエンジニア)が開発・メンテナンスしており、VS Code の拡張機能としても広く使われている。同氏は `markdownlint-cli` や `markdownlint-cli2` も公開している。
- **なぜ重要か**: Markdown は README やドキュメント、ブログなどで広く使われるが、リンク切れや見出しの重複、インデントの不統一が起きやすい。markdownlint を使うと CI/CD パイプラインで自動チェックでき、ドキュメントの品質と一貫性を保てる。
- **ルール体系**は 100 以上のチェック項目(MD001〜MD058)から構成され、カスタマイズや無効化も可能。npm パッケージとして公開されており、Node.js 環境で `npx markdownlint` のように実行する。