Librería Markdown Links

Descripción General

Los archivos Markdown contienen links 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. Por ese motivo, se desarrolló esta librería para verificar los links y reportar algunas estadísticas:

• Total de links encontrados.
• Total de links únicos (que no se repiten en el archivo).
• Total de links rotos.

Instrucciones de instalación

Desde GitHub

Con el comando npm install Geraldine13/lim20181-Track-FE-markdown-list

Ver en archivo package.json la dependencia creada.

Directo con el nombre de la librería

Con el comando npm i mdlinkslaboratoria

Ver en archivo package.json la dependencia creada.

Para usarlo programáticamente en ambos casos, se debe importar con require, ver ejemplo:

Versión

1.0.2

Ejemplos del uso

md-links --help

• Para saber el uso general de la librería colocamos en consola.

md-links ./some/example.md

• Al pasarle sólo la ruta o archivo .md , debe imprimir en consola todos los links encontrados, con los siguientes datos: ruta de ubicación, el link y el nombre.

  • La ruta puede ser Absoluta o Relativa.

md-links ./some/example.md --validate

• Al pasarle la ruta o archivo .md con la opción '--validate' , debe imprimir en consola todos los links encontrados, incluyendo los estados; que para el caso de exitoso será el código '200 OK'.

md-links ./some/example.md --stats

• Al pasarle la ruta o archivo .md con la opción '--stats' , debe imprimir en consola la siguiente estadística:

  • Total: todos los links encontrados.
  • Unique: links únicos/que no se repiten.

md-links ./some/example.md --validate --stats o
md-links ./some/example.md --stats --validate

• Al pasarle la ruta o archivo .md con la opción '--stats' y '--validate' , debe imprimir en consola la estadística anterior (de --stats) y ahora se incluirá el dato de la cantidad de los links rotos:

  • Total: todos los links encontrados.
  • Unique: links únicos/que no se repiten.
  • Broken: Links fallidos o rotos.

BACKLOG

• Para la implementación de la librería se realizó el backlog en el proyecto del repositorio. Ver Backlog