La librería md-links nos permite leer archivos de extensión “.md” y directorios que contengan estos tipos de archivos para extraer todos sus enlaces. Además de realizar consultas HTTP en caso de que los enlaces estés rotos, por último, nos muestra algunas estadísticas básicas como el total y los enlaces únicos del archivo.
Esta librería fue realizada en node.js mediante una función de recursividad para la lectura de los diferentes directorios y archivos Markdown utilizando Axios. También se implementó una CLI que utiliza Inquirer, Chalk y Figlet para una interacción más dinámica con el usuario.
Client
Deploy
npm i @teddiechim/md-links
npm link
Estos para la ejecución de la librería y el CLI.
const {mdLinks} = require(“@teddiechim/md-links”)
Desde la terminal escribiremos el comando md-links, el cual nos mostrará un mensaje donde nos indicará que debemos escribir una ruta (absoluta o relativa) para mostrar los links del directorio o archivo.
También se desplegarán una serie de opciones que el usuario podrá elegir, en éstas están Validate, Stats y Validate and Stats.
Validate nos muestra el estado de los links mediante una consulta HTTP
Stats nos muestra algunas estadísticas básicas sobre nuestros links, en los que se encuentran el total de links y los links únicos que existen en el archivo o directorio
Validate and Stats nos muestra todo lo anterior en la opción de “Stats” y la cantidad de links rotos de hay.
Estos diagramas de flujo se tuvieron en cuenta antes de empezar el código del proyecto
El módulo debe poder importarse en otros scripts de Node.js y debe ofrecer la siguiente interfaz:
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 siguientes propiedad:validate: Booleano que determina si se desea validar los links encontrados.
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: Mensajefailen caso de fallo uoken caso de éxito.
const mdLinks = require("md-links");
mdLinks("./some/example.md")
.then(links => {
// => [{ href, text, file }, ...]
})
.catch(console.error);
mdLinks("./some/example.md", { validate: true })
.then(links => {
// => [{ href, text, file, status, ok }, ...]
})
.catch(console.error);
mdLinks("./some/dir")
.then(links => {
// => [{ href, text, file }, ...]
})
.catch(console.error);El ejecutable de nuestra aplicación debe poder ejecutarse de la siguiente manera a través de la terminal:
md-links <path-to-file> [options]
Por ejemplo:
$ md-links ./some/example.md
./some/example.md http://algo.com/2/3/ Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html algún doc
./some/example.md http://google.com/ GoogleEl comportamiento por defecto no debe validar si las URLs responden ok o no, solo debe identificar el archivo markdown (a partir de la ruta que recibe como argumento), analizar el archivo Markdown e imprimir 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).
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:
$ 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 GoogleVemos 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.
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: 3También podemos combinar --stats y --validate 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: 1Outlook: valen.1540@outlook.com
G-mail: teddiechim@gmail.com