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.
Dentro de una comunidad de código abierto, nos han propuesto crear una
herramienta usando Node.js, que lea y analice archivos
en formato Markdown, para verificar los links que contengan y reportar
algunas estadísticas.
Módulo instalable via npm i md-links-naimerith
El desarrollo del proyecto se realizó a través de Git Projects con una serie de issues y milestones para priorizar y organizar el trabajo, y para poder hacer seguimiento del progreso del mismo. Mediante issues y milestones se pudo organizar y planificar tareas y objetivos concretos.
Para visualizar mejor que hacer y planificar las tareas y objetivos, se realizaron diagramas de flujo.
La librería se puede ejecutar de la siguiente manera a través de la terminal:
- 📌 Si ingresa sólo mdlinks mostrará una guia de procedimiento para ingresar la ruta o pedir ayuda
- Para solicitar ayuda y ver las Instrucciones de Uso:
📌 Ingrese ☛ mdlinks --help
- Para hacer una petición HTTP y averiguar si el link funciona o no.
📌 Ingrese ☛ mdlinks path --validate ó -v
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.
- Para estadísticas básicas sobre los links.
📌 Ingrese ☛ mdlinks path --stats ó -s
El output (salida) será un texto con el total de links y los links unicos.
- Para obtener estadísticas que necesiten de los resultados de la validación podemos combinar comandos;
📌 Ingrese ☛ mdlinks path --stats --validate ó --validate --stats
El output (salida) será un texto con el total de links, los links unicos y los links rotos.
Naimerith Daniela Magdaleno Ovalles