Quarto projeto desenvolvido para o bootcamp da @Laboratória O projeto Markdown Links tem como foco BackEnd (NodeJS e JavaScript) e identifica links em arquivos markdown e seus respectivos status https. Pode ser executado através de CLI.
- 1. Prefácio
- 2. Fluxograma
- 3. Instalação
- 4. Terminal e seus comandos
- 5. Testes
- 6. Checklists de Objetivos Alcançados
- 7. Tecnologias
- 8. Desenvolvido por
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 le e analise 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.
.png)
Instale a biblioteca no terminal através do comando:
npm install https://github.com/ribeirober1208/MD-Links
- Comando validate:
md-links ./files/links.md --validate
- Comando validate, para arquivos vazios:
md-links ./files/empty.md --validate
- Comando stats:
md-links ./files/links.md --stats
- Comando stats, para arquivos vazios:
md-links ./files/empty.md --validate
- A aplicação tem 100% de cobertura:
- [:star2:] Possui CLI.
- [:star2:] É instalável.
- [:star2:] Passa pelo linter.
- [:star2:] Passa pelos testes (npm test).
- [:star2:] Inclui fluxograma de estudos e tomada de decisões no README.md.
- [:star2:] Inclui uma definição de produto clara e informativa no README.md.
- [:star2:] Testes unitários cobrem um mínimo de 70% de statements, functions, lines e branches.
- [:star2:] Package.json: deve possuir nome, versão, descrição, autor, licença, dependências e scripts (pretest, test e etc).
