md-links es un librería que facilita la búsqueda y validación de links contenidos en archivos de formato ".md". Además también proporciona información relevante como: cantidad de links repetidos, únicos, rotos, estatus de la consulta http y mas.
Instalar la libreria por medio de la terminal :
npm install PandArtist93/LIM016-md-links
Para que el usuario pueda ejecutar la librería debe ingresar la siguiente línea de comando a través de la consola.
md-links <path-to-file> [options]
Las rutas implementadas pueden ser absolutas o relativas.
Entre las opciones que puede ingresar el usuario se encuentran:
-
--validate/ -validate/ -v / -V
-
--stats/ -stats/ -s / -S
-
--stats --validate/ -stats -validate/ -s -v/ -S -V / (y las respectivas combinaciones).
El usuario ingresa un path válido.
md-links <path(valido)>
)
El usuario ingresa un path inválido.
md-links <path(invalido)>
El usuario ingresa un path válido y opcion inválida.
md-links <path(valido)> [option (invalido)]
Retorna mensaje de Error
)
El usuario ingresa un path y opcion válidas.
md-links <path(valido)> [option (valido)]
md-links <path> -v
Retorna todos los URL encotrados junto con su respectiva ruta, demas del mensaje y status de consulta http.
md-links <path> -s
Retorna la cantidad de links totales y únicos.
md-links <path> -s -v
Retorna la cantidad de links totales, rotos, únicos y repetidos.
md-links
Retorna mensaje de Error
)
El siguiente proyecto tuvo una duración de 4 semanas, durante el cual se implementaron las siguientes herramientas para la planificación y división de tareas.
-
API
-
CLI
- javascript
- Mardown
- node
- npm
- jest
- CLI
😊 Marielena Aizaga - PandArtist93
Laboratoria - Laboratoria/LIM016-md-links 💛