ESLint Markdown: ESLintでMarkdownファイルをlintしよう
(github.com/lumirlumir)ESLintでMarkdownファイルをlintできる eslint-markdown パッケージを公開しました。
2024年10月3日にESLintがMarkdownサポートを公式発表して以降、公式APIとその方向性に合わせて設計したプラグインです。
このプロジェクトはコミュニティ主導で開発されており、ESLintコアの言語プラグイン開発経験をもとに、安定性、互換性、継続的なメンテナンスを重視して作りました。
eslint-markdown は、ESLintコアのMarkdownサポートパッケージである @eslint/markdown と重複しない20個あまりのルールを提供します。コアルールとあわせて使えば、40個以上のMarkdown関連ルールを活用できます。また、CommonMark、GitHub Flavored Markdown（GFM）、Front Matterをサポートし、recommended、stylistic、base といった共有設定も提供しています。
すでにESLintを使っているプロジェクトであれば、比較的低コストでMarkdown lintingまで同じ設定フローの中に自然に統合できます。ドキュメントとコードの品質管理を1か所でまとめて行いたいチームやプロジェクトに特によく合います。
長期的には、ESLintひとつでさまざまなファイルをまとめてlintできる流れを作り、既存のMarkdown lintingツールである markdownlint や remark-lint を補完し、場合によっては一部を置き換えられる選択肢へと発展させることを目指しています。
今後はスタイルルールを含め、さらに多様なルールを追加していく予定です。MarkdownもJavaScript/TypeScriptのように、同じESLint設定フローの中で一貫して管理できるよう、引き続き磨いていきます。
フィードバックと貢献はいつでも歓迎します。
まだコメントはありません。