Markdown Links

Índice

• 1. Resumo do projeto
• 2. Instalação
• 3. Comandos e funcionalidades
• 4. Tratamento de erros
• 5. Testes
• 6. Ferramentas utilizadas

1. Resumo do projeto

Este projeto consiste em uma API executada pelo Node.js e composta por uma ferramenta de linha de comando (CLI), que permite ao usuário executar uma biblioteca diretamente pelo terminal. A API realiza a leitura de arquivos no formato Markdown, identificando os links contidos no arquivo e seus respectivos status https.

2. Instalação

• npm install md-links-osikmelina

3. Comandos e funcionalidades

A API permite a execução de quatro formas:

• md-links caminho-do-arquivo

Imprime no terminal o caminho do arquivo, a URL encontrada e o texto correspondente ao nome do link:

• md-links caminho-do-arquivo --validate

Acrescenta à listagem anterior o respectivo status https de cada link, indicando quais estão válidos, quais estão quebrados e quais não existem:

• md-links caminho-do-arquivo --stats

Entrega o número total de links encontrados e quantos deles são únicos, ou seja, contabiliza links repetidos uma única vez:

• md-links caminho-do-arquivo --stats --validate

Acrescenta à listagem anterior a quantidade de links válidos/ativos:

4. Tratamento de erros

5. Testes

6. Ferramentas utilizadas