Markdown Links

Resumo do projeto

Este projeto foi desenvolvido no Bootcamp de Desenvolvimento Web da Laboratória, onde foi criado uma ferramenta de linha de comando (CLI) assim como uma biblioteca em Javascript. Este é um projeto backend onde foi utilizado principalmente as tecnologias Node.Js para o desenvolvimento do código e o Jest para execução dos devidos testes.

O principal objetivo dessa biblioteca é realizar leituras de arquivos do tipo Markdown dentro da sua máquina e verificar a presença de links nestes arquivos. Também é possível verificar se os links são válidos ou não e identificar as suas devidas estatísticas. Esta biblioteca é um executável que pode ser chamado tanto por linha de comando, como também pode ser importado com require para usá-lo em qualquer código.

Objetivos de aprendizagem

• JavaScript

• Node.js

• HTTP

Considerações gerais

1) Instalação

O módulo poder ser instalado com o seguinte comando:

npm install md-links-ajuliamm
   

2) CLI (Command Line Interface - Interface de Linha de Comando)

O executável da aplicação pode ser executado da seguinte maneira através do terminal:

md-links [options]

md-links ./caminho-do-arquivo/arquivo.md

Options: --validate e --stats

Ao passar a opção --validate, o módulo faz uma requisição HTTP e verifica se o link funciona ou não retornando seu devido status:

md-links ./caminho-do-arquivo/arquivo.md

Ao passar a opção --stats o output será um texto com estatísticas básicas sobre os links, informando a quantidade de links no arquivo e quantos são únicos:

md-links ./caminho-do-arquivo/arquivo.md --stats

Para obter estatísticas que necessitem dos resultados da validação pode combinar --stats e --validate:

  md-links ./caminho-do-arquivo/arquivo.md --stats --validate

Fluxograma

O planejamento do desenvolvimento do projeto foi feito através do fluxograma abaixo:

Testes

A execução dos testes foi feito através do Jest e todos foram aprovados com 100% de cobertura.