ESLint Markdown : lint vos fichiers Markdown avec ESLint

Le package eslint-markdown, qui permet de linter des fichiers Markdown avec ESLint, a été publié.

Après l’annonce officielle de la prise en charge de Markdown par ESLint le 3 octobre 2024, ce plugin a été conçu en accord avec l’API officielle et l’orientation du projet.

Ce projet est développé par la communauté et a été conçu en donnant la priorité à la stabilité, à la compatibilité et à une maintenance continue, sur la base de l’expérience acquise dans le développement de plugins de langage pour le cœur d’ESLint.

eslint-markdown propose une vingtaine de règles qui ne font pas doublon avec @eslint/markdown, le package de prise en charge de Markdown du cœur d’ESLint. Utilisé avec les règles du cœur, il permet de tirer parti de plus de 40 règles liées à Markdown. Il prend également en charge CommonMark, GitHub Flavored Markdown (GFM) et Front Matter, et fournit aussi des configurations partagées comme recommended, stylistic et base.

Pour les projets qui utilisent déjà ESLint, il est possible d’intégrer naturellement le linting Markdown dans le même flux de configuration à un coût relativement faible. Il convient particulièrement bien aux équipes et aux projets qui veulent gérer en un seul endroit la qualité de leur documentation et de leur code.

À long terme, l’objectif est de créer un flux dans lequel un seul ESLint peut linter ensemble différents types de fichiers, et d’en faire une option capable de compléter, voire dans certains cas de remplacer, des outils de linting Markdown existants comme markdownlint ou remark-lint.

À l’avenir, davantage de règles seront ajoutées, y compris des règles de style. L’idée est de continuer à faire évoluer l’outil pour que Markdown, comme JavaScript/TypeScript, puisse être géré de manière cohérente dans le même flux de configuration ESLint.

Les retours et les contributions sont toujours les bienvenus.

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