Desenvolvido por :

Thalita Nascimento
Linkedin | Github

• 1. Prefácio
• 2. Resumo do projeto
• 3. Instruções de Uso
• 4. As funcionalidades
• 5. Testes
• 6. Planejamento, tarefas e objetivos

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.

Esse projeto tem como objetivo a criação de uma ferramenta de linha de comando (CLI - Command Line Interface - Interface de Linha de Comando) bem como uma biblioteca (library) em Javascript, executado com Node.js. através do terminal:

A CLI permite aos usuários processos tais como : identificar , ler e analisar arquivos no formato Markdown (a partir da rota que recebeu como argumento), para verificar os arquivos que contenham links, imprimir os links encontrados, rota do arquivo e o texto encontrado dentro do link, a ferramenta oferece recursos de validação dos links e geração de estatísticas relacionadas ao conteúdo analisado.

O desenvolvimento do projeto ocorreu em quatro sprints, seguindo um planejamento prévio baseado em um fluxograma/Trello.

Para instalar o módulo, execute o seguinte comando: npm install md-links-thalita-nascimento

Utilizando o comando md-links ./caminhoDaPasta/nomeDoArquivo.md:

• Listagem de links: exibe os links encontrados nos arquivos Markdown, mostrando a rota do arquivo onde foi encontrado o link, a URL encontrada e o texto que aparece dentro do link.

___________________________________________________________________________________

$ md-links ./pasta/texto.md






• Validação de links (options): Se passamos a opção `--validate`, o módulo deve fazer uma requisição HTTP verificar se os links encontrados nos arquivos Markdown estão funcionando corretamente, retornando o código de status HTTP da URL correspondente. o _output_ neste caso inclui a palavra `ok` e `fail` depois da URL, assim como o status da resposta recebida à requisição HTTP feita pela URL.

___________________________________________________________________________________________________________

$ md-links ./pasta/texto.md --validate

---






• Estatísticas de links: exibe o número total de links encontrados, total de links únicos e o número de links que estão funcionando corretamente.

Se passamos a opção --stats o output (saída) será um texto com estatísticas básicas sobre os links.

$ md-links ./pasta/texto.md --stats

---



Também podemos combinar --stats e --validate para obter estatísticas que necessitem dos resultados da validação.

$ md-links ./pasta/texto.md --stats --validate

---



A ferramenta está apta a tratar os erros, exemplo (arquivo localizado na pasta src):

$ md-links ./src/texto.txt

---



$ md-links ./src/texto-vazio.md

---

fluxograma ou pseudocódigo.