Aleja-md-links

version 1.0.5

¿Que es Aleja-Markdown Links? Es una libreria que usa Node.js para leer y extraer los links de tus archivos Markdown, para verificar los links que contengan y reportar algunas estadísticas.

Diagrama de Flujo

Pre-requisitos 📋

Para el correcto funcionamiento de este proyecto necesitas tener instalado Node.js en tu computador.

instalación ⚙️🔧

Para instalar el modulo de md-link en tu proyecto, usa en la CLI el siguiente comando disponible en NPM:

npm i aleja-md-links

En el caso de que falle crear un archivo .npmrc y dentro de este arhivo escribir aleja-md-links: registry=https://registry.npmjs.org/ .

Modo de uso 📌

Para hacer uso de esta herramienta, se debe escribir en la terminal:

md-links <path-to-file>

Donde "path" es la ruta donde se encuentra el archivo a analizar.

Se imprimirá en la terminal, las carpetas encontradas en la ruta, los links contenidos en los archivos.MD.

Como utilizar la librería? - CLI

mdlinks(path)

• El comportamiento por defecto , identifica el archivo markdown (a partir de la ruta que recibe como argumento), analiza el archivo Markdown e imprimime los links que vaya encontrando, junto con la ruta del archivo donde aparece y el texto que hay dentro del link (truncado a 50 caracteres).

Opciones

Existen 3 opciones a utilizar :

("-v, --validate", "Valida el status http de los links");
("-s, --stats","Estadisticas de los links de un archivo markdown");
("-s -v o -s -v ,  --valide --stats","Estadisticas y archivos rotos");

Para ver las opciones que estan utilizar en línea de comando --help o --h

-- validate -v

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.

Por ejemplo:

mdLinks(test.md, --validate || -v)

$ md-links ./some/example.md --validate
./some/example.md http://algo.com/2/3/ ok 200 Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html fail 404 algún doc
 ./some/example.md http://google.com/ ok 301 Google

Vemos que el output en este caso incluye la palabra ok o fail después de la URL, así como el status de la respuesta recibida a la petición HTTP a dicha URL.

--stats --s

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

 $ md-links ./some/example.md --stats
  Total: 3
  Unique: 3

Combinar --stats y --validate --s --v o --v --s

Si pasamos la opción --stats y --valide, se usa para obtener estadísticas que necesiten de los resultados de la validación.

 $ md-links ./some/example.md --stats --validate
 Total: 3
 Unique: 3
 Broken: 1

Planificación

Este proyecto se planificó en un tiempo de casi 3 semanas.

Utilize Trello para comenzar y luego lo pase a milestones y issues en project Md-link almacenado en github.

Dependencias Utilizadas 📋

• "chalk": "^2.4.2",
• "commander": "^3.0.1",
• "eslint": "^6.3.0",
• "eslint-plugin-jest": "^22.15.2",
• "esm": "^3.2.25",
• "fetch": "^1.1.0",
• "filehound": "^1.17.3",
• "jest": "^24.9.0"

Programadora ✒️

• Alejandra Morales