Markdown é uma linguagem de marcação muito popular entre os programadores.
É usada em muitas plataformas que manipulam texto (GitHub, fórum, blogs e etc), e é muito comum encontrar arquivos
com este formato em qualquer repositório (começando pelo tradicional README.md).
Os arquivos Markdown normalmente contém links que muitas vezes estão quebrados, ou que já não são válidos e isso prejudica muito o valor da informação que está ali.
Durante o bootcamp da Laboratória, foi proposto criar uma ferramenta, usando Node.js, que leia e analise arquivos no formato Markdown, para verificar os arquivos que contenham links e mostrar algumas informações, como por exemplo, se são links válidos.
- A biblioteca e script executável (ferramenta de linha de comando - CLI) foram implementados em JavaScript para serem executadas com Node.js.
-
Para usar esta biblioteca, você deve ter instalado o Node.js no seu computador.
-
O módulo é instalável executando o seguinte comando no terminal:
npm install -g luana-aredes/SAP004-md-links.
Ao instalar a biblioteca, é possível utilizá-la pelo arquivo executável que pode ser chamado por linha de comando:
mdLinks <path-to-file>
$ mdLinks ./some/example.md
Também é possível obter uma resposta se o link encontrado é válido, neste caso o comando executado é:
mdLinks <path-to-file> --validate
$ mdLinks ./some/example.md --validate
A função retorna uma promessa (Promise) com uma array de objetos, em que cada objeto representa um link no arquivo, e contém as seguintes propriedades:
Title: Texto indicativo do link dentro do markdown.
URL: URL do link encontrado.
Status: OK