Markdown Links - ferramenta de linha de comando (CLI) e sua biblioteca.

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.

ANA LETICIA B. PRINCE Linkedin | Github

Índice

• 1. Prefácio 🗒️
• 2. Fluxograma 📄
• 3. Instalação 🔽
• 4. Terminal e seus comandos💻
• 5. Testes 📊
• 6. Checklists de Objetivos Alcançados 🏆

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 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.

Fluxograma

Instalação

• npm install md-links-analeticia

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 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, exemplo:

1. O usário digita um arquivo sem extensão .md:

• md-links caminho-do-arquivo-semMd

2. O usuário insere um arquivo vazio:

• md-links caminho-do-arquivo-vazio

Testes

A aplicação foi finalizada com 100% de cobertura nos testes:

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).