Markdown Links

Desenvolvido por: Mislene Moura
Linkedin | Github

Índice

• 1. Prefácio
• 2. Guia de instalação e uso
• 3. Testes Unitários
• 4. Fluxograma
• 5. Objetivos de aprendizagem
• 6. Tecnologias Utilizadas

---

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.

Neste projeto, foi desenvolvido uma biblioteca que lê arquivos Markdown('md') através de uma ferramenta de linha de comando (CLI), tendo como propósito a partir de um módulo do Node.js, fazer a leitura dos arquivos, verificar a existência dos links e suas estatísticas. Para uma melhor visualização das informações no terminal, foi feito também uma estilização no CLI utilizando a biblioteca chalk.

2. Guia de instalação e uso🔍📝

2.1 - Instalação🔍

Para utilizar a biblioteca, instale no seu terminal o seguinte comando:

$ npm install MisleneSM/SAP010-md-links

Após a instalação, assegure possuir um arquivo com links:

2.2 - Pré-requisitos:

• É necessário ter a instalação do Node.js

2.3 - Guia de uso📝

No seu terminal rode o comando md-links + o caminho do arquivo e será retornado o caminho, text e os links do arquivo selecionado, conforme exemplo abaixo:

Options

--validate

Se deseja fazer a validação dos links desse arquivo, utilize a propriedade --validate, o mesmo fará uma requisição HTTP verificando se o link é funcional ou não. Se o link resultar em um redirecionamento a uma URL que responde ok, então consideremos o link como ok. Caso contrário, teremos um retorno de fail, conforme exemplo abaixo:

--stats

Se deseja fazer a verificação das estatísticas básicas dos links desse arquivo, utilize a propriedade --stats, o mesmo retornará o total de links encontrados no seu arquivo e quantos desses são únicos, conforme exemplo abaixo:

--validate & --stats

Também podemos combinar as propriedades. Se deseja verificar a validação dos links e estatísticas básicas do seu arquivo, utilize --validate --stats, o mesmo retornará o total de links encontrados, quantos desses são únicos e quantos estão quebrados. Segue o exemplo abaixo:

3. Testes Unitários✅

Desenvolvido testes unitários abrangendo as funcionalidades do Node.js, garantindo mais segurança na usabilidade da biblioteca.

4. Fluxograma📝

Para melhor visualização do planejamento de tarefas e objetivos de cada etapa, foi realizada a organização do projeto por meio de um fluxograma, conforme imagem abaixo:

5. Objetivos de aprendizagem✅

• Java Script
• Node.js
• Git e GitHub
• Fluxograma

6. Tecnologias Utilizadas✅