npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

md-links-juciele-gomes

v0.1.0

Published

Validate links found in markdown files

Downloads

2

Readme

mdLinks Library

Índice


1. Prefácio

O Markdown é uma linguagem de marcação leve e popular que foi criada para simplificar a formatação de texto em documentos, especialmente para a web. Foi desenvolvido por John Gruber e Aaron Swartz em 2004, e desde então, tornou-se amplamente adotado por sua simplicidade e facilidade de uso.

O principal objetivo do Markdown é permitir que as pessoas escrevam documentos com formatação de maneira rápida e intuitiva, sem a necessidade de aprender linguagens de marcação complexas, como HTML. Com o Markdown, você pode criar facilmente títulos, listas, links, citações, tabelas e muito mais, usando uma sintaxe simples baseada em texto.

A simplicidade do Markdown o torna uma escolha popular entre escritores, blogueiros, desenvolvedores e qualquer pessoa que queira criar conteúdo na web sem se preocupar com detalhes técnicos. Neste prefácio, exploraremos os conceitos básicos do Markdown e forneceremos exemplos para ajudá-lo a começar a usar essa linguagem de marcação de forma eficaz.


2. Resumo do projeto

Este é o projeto 4 do bootcamp Laboratória turma SAP-011, o projeto tem como objetivo a criação de ferramenta de linha de comando (CLI) assim como a sua própria biblioteca (library) em Javascript e executada com Node.js.

Neste projeto temos como foco aprender sobre processos, como interagir com sistemas de arquivos, como fazer consultas de rede, etc.

Desenvolver sua própria biblioteca é uma experiência fundamental para qualquer desenvolvedora, pois te obriga a pensar na interface (API) dos seus módulos e como ela será usada por outras desenvolvedoras.


3. Fluxograma

_Fluxograma


4. Instalação

Para instalçao da biblioteca utilize o comando: npm install mdLinks


5. Comandos no terminal

5.1 Extração dos links:

Para extração e leitura dos links do arquivo .md, utilize o comando:

mdLinks <caminho-do-arquivo>

mdLinks


5.2 Gerar dados estátisticos:

Para gerar dados estátisticos dos links contidos no arquvivo .md utilize o comando:

mdLinks <caminho-do-arquivo> --stats

--stats


5.3 Validação:

Para validar os links contidos no arquvivo .md utilize o comando:

mdLinks <caminho-do-arquvivo> --validate


5.4 Validar e gerar dados estátisticos:

Para validar os links e gerar dados estaticos dos links, utilize o comando: --validate

mdLinks <caminho-do-arquivo> --validate --stats

--validade --stats


5.6 Mensagens de erro:

A partir dos comandos inseridos no terminal podem ser geradas algumas mensagens de erro.

Caso o caminho do arquivo inserido não seja .md a seguinte mensagem de erro será mostrada no terminal:

notMdFile

Caso o arquivo não possua links ou esteja vazio sera mostrada a seguinte mensagem de erro no terminal:

noLinks


6. Testes unitários


🗹 7. CheckList

  • [x] Poder instalar via npm install
  • [x] Guia de uso e instalação da biblioteca
  • [x] Possuir o executável md-links no path (configurado no package.json)
  • [x] Executar sem erros e ter o resultado esperado
  • [x] Implementar --validate
  • [x] Implementar --stats
  • [x] Os testes unitários devem cobrir no mínimo 70% dos statements, functions, lines e branches.

Ferramentas e tecnologias utilizadas


👩‍💻 Desenvolvedora