Foi criado uma ferramenta de linha de comando (CLI) assim como uma biblioteca em Javascript. Este é um projeto backend onde foi utilizado principalmente as tecnologias Node.Js para o desenvolvimento do código e o Jest para execução dos devidos testes.
O principal objetivo dessa biblioteca é realizar leituras de arquivos do tipo Markdown dentro da sua máquina e verificar a presença de links nestes arquivos. Também é possível verificar se os links são válidos ou não e identificar as suas devidas estatísticas. Esta biblioteca é um executável que pode ser chamado tanto por linha de comando, como também pode ser importado com require para usá-lo em qualquer código.
-
JavaScript
-
Node.js
-
HTTP
O módulo poder ser instalado com o seguinte comando:
npm install md-links-ajuliamm
O executável da aplicação pode ser executado da seguinte maneira através do terminal:
md-links [options]
O comportamento padrão ao colocar apenas o caminho do arquivo é devolver apenas os links e suas devidas descrições:
md-links ./caminho-do-arquivo/arquivo.md
Ao passar a opção --validate, o módulo faz uma requisição HTTP e verifica se o link funciona ou não retornando seu devido status:
md-links ./caminho-do-arquivo/arquivo.md
Ao passar a opção --stats o output será um texto com estatísticas básicas sobre os links, informando a quantidade de links no arquivo e quantos são únicos:
md-links ./caminho-do-arquivo/arquivo.md --stats
Para obter estatísticas que necessitem dos resultados da validação pode combinar --stats e --validate:
md-links ./caminho-do-arquivo/arquivo.md --stats --validate
O planejamento do desenvolvimento do projeto foi feito através do fluxograma abaixo:
A execução dos testes foi feito através do Jest e todos foram aprovados com 100% de cobertura.
