- 1. Prefácio
- 2. Resumo do projeto
- 3. Instalação ⭐️
- 4. Funcionalidades
- 5. Considerações Técnicas
- 6. Próximos Passos
- 7. Autoria
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 podem estar
quebrados, ou que já não são válidos, prejudicando muito o valor da
informação que está ali.
Uma comunidade open source nos propôs criar uma ferramenta, usando
Node.js, que leia e analise arquivos no formato
Markdown, para verificar os arquivos que contenham links e mostrar algumas
estatísticas.
O md-links é uma biblioteca que lê arquivos no formato markdown(.md) e retorna os links encontrados neles, apresentando, validações e estados se ainda desejar.
Neste projeto você criará uma ferramenta de linha de comando (CLI) assim como a sua própria biblioteca (library) em JavaScript.
Para instalação global do projeto, execute no terminal:
npm install -g SofiaSimas/SAP004-md-links
Quando requisitada, a biblioteca necessita de alguns parâmetros, opcionais ou não.
Após a instalação, poderá utilizar path para a rota da pasta ou arquivo:
md-links <path-to-file>
options: Um objeto com a seguinte propriedade:validate:(Opcional) Para verificar o statusstats:(Opcional) Para verificar as estatísticas
- http/https.get O método GET solicita a representação de um recurso específico. Requisições utilizando o método GET devem retornar apenas dados.
- Jest Para testes.
- Chalk - Versão 4.1.0
- jsdom - Versão 16.2.2
- marked - Versão 1.1.0
- jest - Versão 26.1.0
- jest-nyancat-reporter - Versão 2.0.0
- Aperfeiçoar os testes,
- Implementar suporte para diretórios e os testes,
- Hacker Edition.
Desenvolvido com