ESLint Markdown: Faça linting de arquivos Markdown com o ESLint

Publicamos o pacote eslint-markdown, que permite fazer linting de arquivos Markdown com o ESLint.

Depois que o ESLint anunciou oficialmente o suporte a Markdown em 3 de outubro de 2024, este plugin foi projetado em conformidade com a API oficial e a direção proposta.

Este projeto está sendo desenvolvido com base na comunidade e foi criado priorizando estabilidade, compatibilidade e manutenção contínua, com base na experiência de desenvolvimento de plugins de linguagem do núcleo do ESLint.

O eslint-markdown oferece cerca de 20 regras que não se sobrepõem ao pacote de suporte a Markdown do núcleo do ESLint, o @eslint/markdown. Quando usado junto com as regras do núcleo, é possível aproveitar mais de 40 regras relacionadas a Markdown. Além disso, ele oferece suporte a CommonMark, GitHub Flavored Markdown (GFM) e Front Matter, e também fornece configurações compartilhadas como recommended, stylistic e base.

Se o seu projeto já usa ESLint, é possível integrar o linting de Markdown de forma natural ao mesmo fluxo de configuração com um custo relativamente baixo. Ele é especialmente adequado para equipes ou projetos que querem gerenciar a qualidade da documentação e do código em um só lugar.

No longo prazo, o objetivo é criar um fluxo em que seja possível fazer linting de vários tipos de arquivos com um único ESLint e evoluir como uma opção que complemente ou, em alguns casos, substitua ferramentas existentes de linting para Markdown, como markdownlint ou remark-lint.

No futuro, pretendemos adicionar regras ainda mais diversas, incluindo regras de estilo. Continuaremos refinando a ferramenta para que o Markdown, assim como JavaScript/TypeScript, possa ser gerenciado de forma consistente dentro do mesmo fluxo de configuração do ESLint.

Feedback e contribuições são sempre bem-vindos.

• GitHub: https://github.com/lumirlumir/npm-eslint-markdown
• Documentação: https://eslint-markdown.lumir.page