Markdown Links
1. Preámbulo
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.
2. Resumen del proyecto
En este proyecto es una herramienta de línea de comando (CLI) y librería en JavaScript, que se ejecuta a través de Node.js que es un entorno de ejecución para JavaScript construido con el motor de JavaScript V8 de Chrome. que nos permite ejecutar Javascript en el entorno del sistema operativo, ya sea tu máquina o un servidor, lo cual nos abre las puertas para poder interactuar con el sistema en sí, archivos, redes, etc.
La herramienta consta de dos partes :
1) JavaScript API
El módulo debe poder importarse en otros scripts de Node.js y debe ofrecer la siguiente interfaz:
mdLinks(path, options)
Argumentos
path: Ruta absoluta o relativa al archivo o directorio. Si la ruta pasada es relativa, debe resolverse como relativa al directorio desde donde se invoca node - current working directory).
options: Un objeto con únicamente la siguiente propiedad:
validate: Booleano que determina si se desea validar los links encontrados.
Valor de retorno:
La función debe retornar una promesa (Promise) que resuelva a un arreglo (Array) de objetos (Object), donde cada objeto representa un link y contiene las siguientes propiedades
Con validate:false:
href: URL encontrada.
text: Texto que aparecía dentro del link ().
file: Ruta del archivo donde se encontró el link.
Con validate:true:
href: URL encontrada.
text: Texto que aparecía dentro del link ().
file: Ruta del archivo donde se encontró el link.
status: Código de respuesta HTTP.
ok: Mensaje fail en caso de fallo u ok en caso de éxito.
2) CLI (Command Line Interface - Interfaz de Línea de Comando)
El ejecutable de nuestra aplicación se ejecuta:
mdLinks path-to-file [options]
Options
--validate
Si pasamos la opción --validate, el módulo debe hacer una petición HTTP para averiguar si el link funciona o no. Si el link resulta en una redirección a una URL que responde ok, entonces consideraremos el link como ok.
--stats
Si pasamos la opción --stats el output (salida) será un texto con estadísticas básicas sobre los links considerando:
{Total: 3, Unique: 3}
También podemos combinar --stats y --validate para obtener estadísticas que necesiten de los resultados de la validación.
{Total: 3, Unique: 3, Broken: 1}
Diagrama de flujo
Instalación e Instrucciones uso
Instalación
Para instalar la libreria posicionese dentro de su carpeta y abra la terminal para colocar el siguiente comando:
npm i md-links-mafer-rodriguez
Modo de uso
El ejecutable de esta aplicación se realiza de siguiente manera a través de la terminal:
npx mdLinks path-to-file [options]
1.- Si ejecutamos en nuestra terminal el argumento path, de esta manera: mdLinks path-to-file le estamos indicando a la herramienta la ruta del archivo que quieres revisar, puede ser una ruta relativa o absoluta. y nos retornará un resumento de los links de esa ruta. Lo cual se verá de la siguiente manera:
2.- Si ejecutamos en nuestra terminal el argumento [options] , de las cuales tenemos disponibles:
--validate , --stats , o ambas --validate -- stats va a evaluar ciertas características:
--validate : El módulo hace una petición HTTP para averiguar si el link funciona o no.
--stats : El módulo nos muestra las estadísticas básicas sobre los links, el total de links y los links únicos.
--validate --stats : El módulo entregará estadistica completa de los links, en donde mostrará también los links rotos o no válidos.
Planificación de Proyecto:
Este proyecto se realizó en 4 sprints, utilizando la herramienta de GIT HUB PROJECTS
