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

danilarat_md-links

v0.2.2

Published

herramienta de línea de comando (CLI) así como tu propia librería (o biblioteca - library) en JavaScript.

Downloads

10

Readme

Markdown Links

mdLinks

Índice


1. Documentacion técnica de la libreria

Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchísimas plataformas que manejan texto plano (GitHub, foros, blogs, ...) y es muy común encontrar varios archivos en ese formato en cualquier tipo de repositorio (empezando por el tradicional README.md).

Estos archivos Markdown normalmente contienen links (vínculos/ligas) que muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de la información que se quiere compartir.

Esta herramienta de línea de comando (CLI) tiene como objetivo revisar los archivos .md y verificar si contienen links y a su vez indicar si estos son validos o no.

La herramienta consta de dos partes :

1) JavaScript API

El módulo debe poder importarse en otros scripts de Node.js y debe ofrecer la siguiente interfaz:

mdLinks(path, options)

Argumentos

  • path: Ruta absoluta o relativa al archivo o directorio. Si la ruta pasada es relativa, debe resolverse como relativa al directorio desde donde se invoca node - current working directory).
  • options: Un objeto con únicamente la siguiente propiedad:
    • validate: Booleano que determina si se desea validar los links encontrados.

Valor de retorno

La función debe retornar una promesa (Promise) que resuelva a un arreglo (Array) de objetos (Object), donde cada objeto representa un link y contiene las siguientes propiedades

Con validate:false :

  • href: URL encontrada.
  • text: Texto que aparecía dentro del link (<a>).
  • file: Ruta del archivo donde se encontró el link.

Con validate:true :

  • href: URL encontrada.
  • text: Texto que aparecía dentro del link (<a>).
  • file: Ruta del archivo donde se encontró el link.
  • status: Código de respuesta HTTP.
  • ok: Mensaje fail en caso de fallo u ok en caso de éxito.

2) CLI (Command Line Interface - Interfaz de Línea de Comando)

El ejecutable de nuestra aplicación se ejecuta:

mdLinks <path-to-file> [options]

Options

--validate

Si pasamos la opción --validate, el módulo debe hacer una petición HTTP para averiguar si el link funciona o no. Si el link resulta en una redirección a una URL que responde ok, entonces consideraremos el link como ok.

--stats

Si pasamos la opción --stats el output (salida) será un texto con estadísticas básicas sobre los links considerando:

{Total: 3, Unique: 3}

También podemos combinar --stats y --validate para obtener estadísticas que necesiten de los resultados de la validación.

{Total: 3, Unique: 3, Broken: 1}

2. Diagrama de flujo

A.- API

mdLinks

B.- CLI

mdLinks

3. Guía de uso e instalación de la librería

instalacion

npm i danilarat_md-links

Modo de Uso

El ejecutable de nuestra aplicación se realiza de siguiente manera a través de la terminal: mdLinks <path-to-file> [options]

1.- mdLinks: Con este comando comienzas a utilizar la Herramienta, te muestra una pequeña descripcion de su uso.

2.- path: Argumento con el cual le indicas a la herramienta la ruta del archivo que quieres revisar, esta ruta puede ser relativa o absoluta. - Al agregar este argumento sin options igualmente entregara un resumen de los links de la ruta consultada.

3.- options: Argumento con el cual le indicas a la herramienta si deseas evaluar ciertas caracteristicas:

  • --validate: el módulo debe hacer una petición HTTP para averiguar si el link funciona o no.
  • --stats : Si pasamos la opción --stats el output (salida) será un texto con estadísticas básicas sobre los links, el cual contendra Total de links, y total de links sin repetir.
  • --stats + --validate: entregara estadistica completa en la cual se agregara broken que son los archivos rotos o no validos.

Ejemplos:

mdLinks

comando mdLinks

mdLinks + path

mdLinks + path

mdLinks + path + options (una o ambas)

--validate

mdLinks + --validate

--stats

mdLinks + --stats

--validate --stats

mdLinks + --validate + --stats

4. Board

El proyecto se trabajo en 4 Sprints, en los cuales se organizo segun Diagramas de flujo establecidos.

GitHub Projects

project