Markdown es un lenguaje de marcado ligero utilizado en diferentes plataformas que manejan texto plano por lo que es común encontrar variedad de archivos en ese formato en cualquier tipo de repositorio.
Generalmente en estos archivos se comparte información relevante del desarrollo y puede venir acompañado de links, los cuales en diferentes casos pueden estar rotos por lo que afecta en la comunicación con quién está leyendo.
Aunado a este planteamiento, en este proyecto se desarrolló una librería en Node.js, su función es analizar los archivos markdown y extraer los enlaces que se encuentran dentro de estos.
Esta librería estará disponible de dos formas:
-
Módulo publicado en GitHub, para que las usuarias puedan instalar e importar en otros proyectos.
-
Interfaz de línea de comandos (CLI) para poder ser usada desde la terminal. La cual puede proporcionar la validación de enlaces y estadísticas.
Ejecuta este comando en la terminal
npm install brenah00/DEV009-md-links
Una vez que se haya completado la instalación, puedes usarla en:
Para ejecutarlo escribe lo siguiente:
mdlinks ruta-archivo-o-directorio [opciones]
Esto te mostrará todos los enlaces encontrados en el archivo o directorio proporcionado con los siguientes parámetros:
- href - Enlace
- text - Texto al que hace referencia el enlace
- file - Ruta en la que el enlace fue encontrado
Esta librería tiene 2 opciones para su ejecución:
Validará si el link funciona correctamente o si está roto, añadiendo a cada enlace los parámetros:
- status - Códigos de respuesta HTTP
- request - La solicitud fue exitosa o falló
Mostrará estadísticas de los links como:
- Total - Cantidad de enlaces encontrados
- Unique - Cantidad de enlaces únicos, es decir, sin repetición.
En caso de que esta opción se combine con --validate, se agregarán dos estadísticas:
- OK - Cantidad de enlaces que redirigen correctamente.
- Broken - Cantidad de enlaces rotos.
Esta librería fue desarrolla con nodeJS y Javascript. El siguiente diagrama de flujo corresponde a la lógica programática.
