md-links-adilafreitas v0.3.0
Markdown Links - CLI e Library (Node.js)
Índice
Prefácio
Markdown é 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 podem estar quebrados, ou que já não são válidos, prejudicando muito o valor da informação que está ali.
Nesse projeto, criou-se uma ferramenta, usando Node.js, que lê e analisa arquivos no formato Markdown, para verificar os arquivos que contenham links e mostrar algumas estatísticas. Neste projeto, foi criado uma ferramenta de linha de comando (CLI) assim como a sua própria biblioteca (library) em Javascript usando o Node.js.
Fluxograma
Instalação
npm install md-links-adilafreitas
Comandos no terminal
O usuário que utilizar a ferramenta desenvolvida, poderá localizar os links em um arquivo de interesse com o comando abaixo:
md-links caminho-do-arquivo
A segunda possibilidade de uso é inserir o comando --validate após o caminho do arquivo, para que assim a ferramenta informe os links que estão com erros.
md-links caminho-do-arquivo --validate
A terceira funcionalidade, é verificar informações resumidas sobre os links, acrescentando o comando --stats:
md-links caminho-do-arquivo --stats
Também é possível utilizar as duas opções acima, juntas:
md-links caminho-do-arquivo --stats --validate
A ferramenta está apta a tratar os erros de arquivos não .md, exemplo:
md-links package.json
Testes
A aplicação foi finalizada com cobertura maior de 70%.
Checklist
- ✅ Possui CLI;
- ✅ É instalável;
- ✅ Passa pelo linter;
- ✅ Passa pelos testes (npm test);
- ✅ Inclui fluxograma de estudos e tomada de decisões no README.md;
- ✅ Testes unitários cobrem um mínimo de 70% de statements, functions, lines e branches;
- ✅ Package.json: deve possuir nome, versão, descrição, autor, licença, dependências e scripts (pretest, test e etc).