md-links-danila-ramos v0.1.1
🔗💻 Links de Remarcação (Markdown Links) 🔗💻
Markdown é um formato simples de markup, isso é, de marcação de texto. A ideia é marcar um texto informando o que é importante, o que é um tópico, o que são links e imagens, sem a necessidade de utilizar marcações mais complexas, como o HTML.
- 1. Prefácio
- 2. Fluxograma
- 3. Instalação
- 4. Terminal e seus comandos
- 5. Testes
- 6. Checklists de Objetivos Alcançados
1. Prefácio
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.
2. Fluxograma
3. Instalação
npm install md-links-danila-ramos
4. Terminal e seus comandos
O usuário que utilizar a ferramenta desenvolvida, poderá localizar os links em um arquivo de interesse com o comando abaixo:
md-links ./arquivos/texto.md
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 ./arquivos/texto.md --validate
Verificar informações resumidas sobre os links, acrescentando o comando --stats:
md-links ./arquivos/texto.md --stats
Também é possível utilizar as duas opções acima, juntas:
md-links ./arquivos/texto.md --stats --validate
Mensagem de retorno quando digitado um arquivo que não existe:
md-links ./arquivos/pasta
5. Teste
6. Checklists de Objetivos Alcançados 🏆
- :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).