ESLint Markdown: Linten Sie Markdown-Dateien mit ESLint

Wir haben das Paket eslint-markdown veröffentlicht, mit dem sich Markdown-Dateien mit ESLint linten lassen.

Nachdem ESLint am 3. Oktober 2024 die Unterstützung für Markdown offiziell angekündigt hat, ist dieses Plugin passend zur offiziellen API und Ausrichtung konzipiert.

Dieses Projekt wird communitybasiert entwickelt und wurde mit Blick auf Stabilität, Kompatibilität und kontinuierliche Wartung erstellt – auf Grundlage von Erfahrungen aus der Entwicklung von Sprach-Plugins für den ESLint-Core.

eslint-markdown bietet rund 20 Regeln, die sich nicht mit dem Markdown-Support-Paket @eslint/markdown aus dem ESLint-Core überschneiden. Zusammen mit den Core-Regeln lassen sich damit mehr als 40 Markdown-bezogene Regeln nutzen. Unterstützt werden außerdem CommonMark, GitHub Flavored Markdown (GFM) und Front Matter; zusätzlich werden Shared Configs wie recommended, stylistic und base bereitgestellt.

Wenn Ihr Projekt bereits ESLint verwendet, lässt sich Markdown-Linting mit vergleichsweise geringem Aufwand natürlich in denselben Konfigurationsablauf integrieren. Besonders gut geeignet ist es für Teams oder Projekte, die Qualitätsmanagement für Dokumentation und Code an einem Ort zusammenführen möchten.

Langfristig ist das Ziel, einen Workflow zu schaffen, in dem sich mit ESLint allein verschiedene Dateitypen gemeinsam linten lassen, und eine Option zu entwickeln, die bestehende Markdown-Linting-Tools wie markdownlint oder remark-lint ergänzt oder in manchen Fällen ersetzt.

Künftig sollen weitere Regeln, einschließlich Stilregeln, hinzukommen. Markdown soll sich – ähnlich wie JavaScript/TypeScript – konsistent innerhalb desselben ESLint-Konfigurationsablaufs verwalten lassen, und wir werden das weiter verfeinern.

Feedback und Beiträge sind jederzeit willkommen.

• GitHub: https://github.com/lumirlumir/npm-eslint-markdown
• Dokumentation: https://eslint-markdown.lumir.page