Markdown Links - Versión PenLogos

Índice

• 1. ¿Qué es esta librería?
• 2. Instalación
• 3. Implementación
• 4. Módulos auxiliares
• 5. Manejo del módulo desde línea de comandos
• 6. Dependencias

1. ¿Qué es esta librería?

Es una API que permite la validación de links existentes en archivos Markdown. Está hecha a partir de cinco módulos que dividen el proyecto: la función principal mdLinks, las funciones auxiliares importadas para la primera 'function.js', un módulo encargado de la validación 'validate.js', un módulo que da estadísticas sobre la validación 'stats.js' y un archivo que permite la implementación de la CLI y el uso global de la función principal 'cli.js'.

2. Instalación

npm install Penlogos/DEV011-md-links ó npm i penlogos-md-links

Se usa Node.js como entorno de ejecución. La API está disponible para instalarse directamente desde Github ejecutando el comando desde la terminal en un repositorio local inicializado con un package.json básico. Sólo se requiere la instalación previa de Node.js.

3. Implementación

const mdLinks = require('penlogos-md-links')

La API permite la importación del módulo principal a través de require.

Ejemplo de implementación:

const validateFileLinks = require("md-links")

validateFileLinks.mdLinks('./Archivos-de-prueba-copia/Prueba-con-links.md', true, true)
.then(res => console.log(res))
.catch(error => console.log(error))

En este ejemplo, la importación del método y su asignación a la variable validateFileLinks permiten hacer uso de la función principal. Admite 3 argumentos: el primero, la ruta relativa o absoluta del archivo markdown a validar, el segundo, indica si se quieren validar los links encontrados al interior del archivo, el tercero, si se quieren visualizar las estadísticas de la validación en consola. Estos dos últimos arrojan valores boleanos, por lo que son parámetros opcionales, que de no llamarse, el módulo toma como false.

Los demás módulos de la librería también pueden importarse haciendo uso de las rutas relativas. Ejemplo de importación e implementación de otro módulo:

validate.js:

const { codeStatus } require('./node_modules/md-links/src/validate.js')

codestatus('https://www.link-no-encontrado.com') //muestra en la terminal el código HTTP//
.then(res => console.log(res))
.catch(error => console.log(error))

4. Módulos auxiliares

Estos son los demás módulos que se pueden importar para utlizarse con require('rutarelativa')

function.js:

absolutePath() //devuelve la ruta absoluta de una ruta relativa//

fileExistence() //verifica si la ruta existe en el disco duro//

pathExtension() //valida si un archivo es de tipo markdown//

fileReading() //devuelve el contenido de un archivo de tipo markdown//

fileParsing() //'parsea' un contenido markdown en un array de tokens//

stats.js:

statsData() //cuenta la propiedad ok con valor 'ok' de un objeto en todas las posiciones de un array//

5. Manejo del módulo desde línea de comandos

El módulo permite la utilización de la función mdLinks directamente desde la línea de comandos, desde cualquier ubicación dentro del repositorio local sin necesidad de ninguna implementación, sólo con la instalación. Permite el mismo uso de los argumentos, así:

mdLinks 'rutarelativa.md' //arroja los links encontrados, la ruta absoluta del archivo y el texto del link.//

mdLinks 'rutarelativa.md' --validate //añade el estado del link (200, por ejemplo) y los estados 'ok' si funciona, 'fail' si está roto.//

mdLinks 'rutarelativa.md' --stats //entrega el número total de enlaces analizados, de enlaces funcionales y de enlaces rotos.//

Admite también ambos argumentos al tiempo, dando toda la información en conjunto.

6. Dependencias

El paquete se vale de los !CommonsJs-Modules y los fs-Modules de Node para las funciones auxiliares del módulo principal. También se usa la librería de parseado !Markdown-it.