- 1. Introducción
- 2. Instalación
- 3. Guía de uso
- 4. Ejemplos de uso
- 5. Diagrama de flujo
- 6. Dependencias
Md-links es una herramienta para línea de comando (CLI tool), que permite obtener los links de archivos markdown, revisar si son funcionales o si se encuentran rotos y obtener estadísticas sobre el conjunto de links, como el total de links, cuántos estan rotos y cuántos son únicos.
Para esto necesitaremos una ruta, la cual puede ser relativa o absoluta, esta ruta puede pertenecer a un archivo o una carpeta. Si se ingresa una carpeta con subcarpetas, la herramienta iniciará una búsqueda recursiva pasando por todas las subcarpetas.
Esta herramienta ha sido desarrollada con Javascript, usando Node.js y diversas dependencias para manejar las peticiones HTTP y mejorar la de interfaz de usuario.
Para instalar la herramienta debemos recordar instalar de forma global usando --global o -g en el comando. Podemos utilizar dos comandos, el que pertenece a la versión de este repositorio de GitHub o el de la publicación de npm.
npm install --global G9D4/LIM016-md-links
npm install -g g9d4-md-links
- Una vez instalada, podremos invocar a través de la terminal usando el comando la siguiente sintáxis:
md-links <ruta> [opciones]
Md-links puede ser invocada solo con la ruta, devolviendo los links encontrados, cada uno con el título dado al link y su ruta absoluta. Si nuestra ruta no conduce a un archivo .md obtendremos un mensaje de error.
También puede ser invocada usando sus dos opciones validate y stats, pueden usarse individualmente o al mismo tiempo.
Validate (--validate o -v): además de los valores básicos, devolverá el código de respuesta HTTP y un mensaje OK o FAIL dependiendo de si el código de respuesta es satisfactorio.
Stats (--stats o -s): devolverá dos resultados de la búsqueda, el total de links encontrados y cuántos son únicos.
Obtendremos la información básica, una lista de los links (href), cada uno con su título (text) y ruta (file)
Obtendremos además de la información básica, el código de estado HTTP (status) y el mensaje de OK o FAIL (ok), dependiendo del código obtenido.
Obtendremos el total de links (total) y la cantidad de links únicos (unique).
Obtendremos todos los resultados y la cantidad de links "rotos" (broken).
Obtendremos la sintaxis para usar la herramienta, la lista de opciones y un ejemplo de uso
Ingresar la ruta es necasario para el funcionamiento de la herramienta
Al utilizar una opción no predeterminada, nos ofrece la opción de pedir ayuda con --help
Si la ruta no existe
Si la ruta no contiene archivos md
"axios": "^0.25.0"
"yargs": "^17.3.1"
"chalk": "^2.4.1"