CLI

Ejecutable del módulo mdLinks.

Logo de la librería en el CLI.

El ejecutable se ejecuta de la siguiente manera a través de la terminal:

md-links [options]

Por ejemplo:

$ md-links ./some/example.md

En consola nos mostraría algo así:

El comportamiento por defecto no debe validar si las URLs responden ok o fail, solo debe identificar el archivo markdown (a partir de la ruta que recibe como argumento), analizar el mismo e imprimir los links que vaya encontrando, junto con la ruta del archivo donde aparece y el texto dentro del link.

Options:

--validate

Si pasamos la opción --validate, el módulo realiza 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

Nos mostraría algo así:

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 de 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

Nos mostraría algo así:

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

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

En ambos casos, nos mostraría algo así:

Observación:

La interfaz de línea de comando (CLI) realiza las siguientes validaciones:

Las imágenes corresponden a las validaciones que realiza el CLI.