/SAP006-md-links

🔎 [BACK-END] Md-links é uma lib que identifica URLs e seus status http em arquivos markdown. Criada usando NodeJS

Primary LanguageJavaScript

Markdown Links

Desenvolvido com 🍕 e ☕️ por Carolina Alvim.

Resumo

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.

Com esta lib é possivel:

  • analisar arquivo com extensão .md;
  • verificar se há links no arquivo markdown;
  • nao encontrando, emitir msg avisando que não há links;
  • caso encontre links, analisar se os links funcionam;
  • retornar lista com os links identificados;
  • retornar com o status http de cada link encontrado;

Instalação

NPM

No terminal, executar o comando:

npm i md-links-caroalvim

Após a instalação, execute a lib com o comando npx md-links-caroalvim <path-to-file>

  • Exemplo: npx md-links-caroalvim ./files/text-for-test.md

Para avaliar cada link e receber a lista com os links e os status http, executar o comando: npx md-links-caroalvim <path-to-file> validate

  • Exemplo: npx md-links-caroalvim ./files/text-for-test.md validate

*** O caminho do arquivo pode ser relativo ao diretório de onde você está executando a lib, ou absoluto.

Link no NPM

Implementações futuras

  • Adicionar Eetatísticas;

Tecnologias utilizadas


Node Js git vscode github