- 1. Preámbulo
- 2. Descripción del módulo
- 3. Documentación del API
- 4. Uso de la librería
- 5. Criterios de aceptación mínimos del proyecto
- 6. Entregables
- 7. Hacker edition
- 8. Pistas, tips y lecturas complementarias
- 9. Checklist
- 10. Achicando el problema
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.
md-links es una herramienta que usa Node.js, para leer y analizar archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.
La libreria te permite extraer todos los enlaces dentro de un archivo de tipo Markdown(md), ademas, identifica cuales son los codigos de respuesta de las consultas y realizar estadisticas(enlaces rotos, unicos y cuatos son en su totalidad).
Para hacer uso de la librería debes instalarla desde NPM, a continuacion los detalles:
Instalación por npm:
npm i lorrainegelisdiaz_mdlinks
Para llevar a cabo el proyecto se hizo necesario realizar un diagrama de flujo. El cual les muestro a continuación:
Este proyecto se conforma de la siguiente manera:
-
JavaScript API: Contiene funciones síncronas utilizando metodos de node,js como lo son; fileSystem y path. Se hizo necesario utilizar paquetes npm como: marked para convertir el texto de un archivo markdown a elementos html y junto con el custom renderer se puede extraer las propiedades de un elemento ancla, node-fetch para realizar las peticiones y obtener el status de los links, y por ultimo, no menos importante, contamos con la participación de filehound que nos ayuda con el tema de la recursividad.
-
CLI (Command Line Interface - Interfaz de Línea de Comando) cli.js, posee el metodo de process.argv de node para poder capturar el input del usuario y luego una serie de condicionales para ver por consola el consumo de la promesa. Finalmente, para otorgar colores predeterminados por la consola, estoy utilizando una libreria denominada ansiColors.
El ejecutable de esta librería se debe poder ejecutar de la siguiente manera a través de la terminal: md-links [options]
Por ejemplo:
1.Cuando ingresas una ruta incorrecta:
2.Cuando ingresas una ruta que no posea links:
3.Cuando ingresas el comando --help visualizaras una sección de ayuda:
- Cuando ingresas una ruta correcta, pero sin las respectivas opciones:
- Cuando ingresas una ruta correcta, con la opción --validate:
- Cuando ingreses una ruta correcta y con la opción --stats:
- Cuando ingreses una ruta y las opciones --validate --stats:
Autora: Lorraine Gelis Diaz
Proximamente más versiones y mejoras en el código.. ✌️