danielablancom-md-links v0.1.4
Markdown Links
Es una librería que encuentra todos los links dentro de un archivo Markdown. Se encarga de analizar dichos archivos dentro del directorio, otorgando diferentes datos y estadisticas. Entre ellos, el estado de cada link, permitiendo verificar si se encuentran funcionales o no. Todos estos resultados son visibles desde la terminal.
Guía de uso
Instalación
Instalar previamente npm y Node.js en tu computador.
Ejecuta el siguiente comando en la terminal.
$ npm i danielablancom-md-links Uso
- Para hacer uso de la librería ejecuta el siguiente comando en la terminal de tu archivo.
$ node tuarchivo.js tuarchivo.md- Para ver el total de links y total de links únicos ejecuta el siguiente comando en la terminal.
$ node tuarchivo.js tuarchivo.md --validate o node tuarchivo.js tuarchivo.md --v- Para ver la cantidad de links únicos y totales ejecuta el siguiente comando en la terminal.
$ node tuarchivo.js tuarchivo.md --stats o node tuarchivo.js tuarchivo.md --s- Para ver estadísticas de tus links ejecuta el siguiente comando en la terminal.
$ node tuarchivo.js tuarchivo.md --s -v o node tuarchivo.js tuarchivo.md ---stats --validate- Para utilizar esta librería en un proyecto diferente, solo debes realizar la instalación y ejecutar el siguiente comando en la terminal.
$ npx danielablancom-md-links tuarchivo.md - Sigue los comandos para ver el estado o las estadísticas de los links.
Opciones
- Si pasamos la opción -validate o -v, así es como deberías poder ver los resultados en la terminal.
- Si pasamos la opción -stats o -s el output (salida) arrojará los datos del total de links y links únicos.
- También podemos combinar -stats y -validate o -s y -v para obtener estadísticas que necesiten de los resultados de la validación.
Dependencias
Para poder llevar a cabo esta librería fue necesario instalar algunas dependencias fuera del entorno de node js. Como por ejemplo:
Módulo chalk. La misma se utilizò para colocar colores a las respuestas del paquete por consola.
Módulo marked. Compilador de bajo nivel para analizar el marcado sin almacenar en caché o bloquear durante largos períodos de tiempo.
Fuera de node js se utilizaron las siguientes dependencias:
Módulo process con
process.argv[]. Para obtener la ruta del archivo ingresado por el usuario en la terminal.Módulo path. Para poder normalizar una ruta y obtener posteriormente la ruta absoluta.
Módulo fs.existsSync. Permite saber si la ruta ingresada existe.
Módulo fs.lstatSync. Permite conocer si la ruta ingresada pertenece a un directorio.
Módulo fs.readdir. Lee asincrónicamente todo el contenido que se encuentra dentro del directorio.
Módulo fs.readFile. Lee asincrónicamente todo el contenido de un archivo.