0.2.1 • Published 2 years ago
md-bear-links v0.2.1
Markdown Links
1. MD-BEAR-LINKS
:bear: md-bear-links es una libreria de linea de comando CLI el cual permite indentificar, validar y dar estadisticas de loas URL que contengan los archivos de formato MarkDown .
2. Link de instalacion
Instalar la libreria via npm i md-links
3. Guia de Uso
A través de la terminal:
HELP OPTION : md-bear-links --help o md-bear-links --h.
WITHOUT OPTIONS : md-bear-links --validate o md-bear-links --v.
VALIDATE OPTION : md-bear-links --validate o md-bear-links --v.
VALIDATE & STATS OPTION : md-bear-links --validate --stats o md-bear-links --v --s.
STATS OPTION : md-bear-links --stats o md-bear-links --s.
MANEJANDO ERRORES
Ruta no existe
4. Diagramas
Diagrama API
Diagrama CLI
5. Dependencias Utilizadas
"chalk": "^2.4.1",
"jsdom": "^19.0.0",
"markdown-it": "^12.3.2",
"node-fetch": "^2.6.7",
"yargs": "^17.3.1"
6. Fuente
Repositorio de Laboratoria: :Se encuentran todas las condiciones y herramientas a trabajar para el proyecto.
7. Autora
Lucerogoga :bear:
8. Checklist
General
- :bear: Puede instalarse via
npm install --global <github-user>/md-links
README.md
- :bear: Un board con el backlog para la implementación de la librería.
- :bear: Documentación técnica de la librería.
- :bear: Guía de uso e instalación de la librería
API mdLinks(path, opts)
- :bear: El módulo exporta una función con la interfaz (API) esperada.
- :bear: Implementa soporte para archivo individual
- :bear: Implementa soporte para directorios
- :bear: Implementa
options.validate
CLI
- :bear: Expone ejecutable
md-links
en el path (configurado enpackage.json
) - :bear: Se ejecuta sin errores / output esperado
- :bear: Implementa
--validate
- :bear: Implementa
--stats