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.
Este proyecto es una librería de Node.js que permite leer, analizar, extraer y generar estadísticas de los links de un archivo o directorio en formato .md
-
Realice un diagrama de flujo con la interfaz que debe llevar la CLI
-
JavaScript API
- Recibe una ruta absoluta o relativa al archivo o directorio y siempre que sea relativa la convertira en absoluta.
- Recibe validate que es un booleano que determina si se desea validar los links encontrados.
- CLI (Command Line Interface)
La aplicación se ejecuta de la siguiente manera a través de la terminal:
mdlinks path-to-file [options]
Si ingresas una ruta valida sea archivo o directorio
Si ingresas una ruta valida con la opción --validate
Si ingresas una ruta valida con la opción --stats
Si ingresas una ruta valida con la opción --validate --stats
Si necesitas recordar los comandos puedes poner la opción --help
