Es una Herramienta que lee y analiza archivos en formato Markdown usando Node.js, para verificar los links que contengan, 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.
En el caso de que desees clonar este repositorio, simplemente deberás escribir en tu consola :
$ npm install
En el caso de querer instalarlo en tu proyecto deberás escribir la siguiente línea de comando :
$ npm install save https://github.com/RocioAl/LIM009-fe-md-linksEsto hará que se instalen las dependencias, para que el módulo funcione correctamente.
Este módulo tiene una función principal llamada mdlinks, que tiene dos parametros :
md-links <path-to-file> [options]
`path`: Ruta absoluta o relativa al archivo o directorio
`options`: Un objeto con las siguientes propiedades:(validate, stats)Podrá ejecutarse de la siguiente manera a través de la terminal:
Por ejemplo:
$ md-links ./some/example.md
./some/example.md http://algo.com/2/3/ Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html algún doc
./some/example.md http://google.com/ Google
* $ md-links ./some/example.md
Resultado:
el nombre del link, y la URL de este link.
* $ md-links./some/example.md --validate
Resultado:
Lo anterior incluyendo el status de los links
* $ md-links ./some/example.md --stats
Resultado:
cantidad de links, rotos y buenos
* $ md-links ./some/example.md --validate --stats ó --v --s
Resultado:
cantidad de links, rotos y buenos--validate o --v
Si pasamos la opción --validate o --v, 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 // ✓'. El output en este caso incluye la palabra // ✓' , // X o CERTIFICADO EXPIRADO después de la URL, así como también devolverá la validacion o status de los links (status: 200, 404) de la respuesta recibida a la petición HTTP a dicha URL.
--stats o --s
Si pasamos la opción --stats o --s el output (salida) devolverá la cantidad de links que se encuentran en buen estado y cuantos están rotos, además del total de links encontrados en el archivo.md(string con estadísticas básicas sobre los links)
- Se crea el flujograma para tener una guía de la implementación del proyecto
- Adicionalmente se crea el pseudocodigo para crear las funciones y saber su input, output y los posibles métodos a implementar-.
- Acerca de Node.js - Documentación oficial
- Node.js file system - Documentación oficial
- Node.js http.get - Documentación oficial
- Node.js - Wikipedia
- What exactly is Node.js? - freeCodeCamp
- ¿Qué es Node.js y para qué sirve? - drauta.com
- ¿Qué es Nodejs? Javascript en el Servidor - Fazt en YouTube
- ¿Simplemente qué es Node.js? - IBM Developer Works, 2011
- Node.js y npm
- Módulos, librerías, paquetes, frameworks... ¿cuál es la diferencia?
- Asíncronía en js
- NPM
- Publicar packpage
- Crear módulos en Node.js
- Leer un archivo
- Leer un directorio
- Path
- Linea de comando CLI
- Promise
- Comprendiendo Promesas en Js