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 librería cuenta con un ejecutable CLI via npm y una interfaz que podra ser importado con require, el detalle de cada uno líneas abajo.
Para utilizar este módulo programaticamente deberas importarlo en tu archivo .js así:
####const mdLinks = require('./md-links')
El módulo ofrece la siguiente interfaz:
mdLinks(path, options)
path
: Ruta absoluta o relativa al archivo o directorio.options
: Un objeto con las siguientes propiedades:
validate
: Booleano que determina si se desea validar los links
encontrados.La función retorna una promesa (Promise
) que resuelve a un arreglo (Array
) de objetos (Object
), donde cada objeto representa un link y contiene las siguientes propiedades:
href
: URL encontrada.text
: Texto que aparecía dentro del link (<a>
).file
: Ruta del archivo donde se encontró el link.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);
Para instalar este módulo lo puedes realizar via npm install gloryrojas/md-links
.
El ejecutable de nuestra aplicación puede 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/ Google
El comportamiento por defecto no valida si las URLs responden ok o no, solo identifica el archivo markdown (a partir de la ruta que recibe como argumento), analiza el archivo Markdown e imprime 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).
--validate
Si pasamos la opción --validate
, el módulo hace 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 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
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
Unicos: 3
Tambié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: 1
Antes de empezar a codear se planteó el flujo de la API md-links tal como se muestra en la siguiente imagen.
El flujo para la CLI es el siguiente: