Librer铆a creada con Node.js que lee y analiza archivos
en formato Markdown
, para verificar los links que contengan y reportar
algunas estad铆sticas.
Para ejecutar e instalar este m贸dulo:
npm i @lorena_alvarez/md-links -g
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 las siguientes propiedades:validate
: Booleano que determina si se desea validar los links encontrados.
href
: URL encontrada.text
: Texto que aparec铆a dentro del link (<a>
).file
: Ruta del archivo donde se encontr贸 el link.
La 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/ 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).
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 Google
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
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