Markdown is a very popular lightweight markup language among developers. It is used on many platforms they handle plain text (GitHub, forums, blogs, ...), and it is very common to find several files in that format in any type of repository.
These Markdown
files usually contain links (links) that are often broken or no longer valid, and that greatly damages the value of the information that you want to share.
The Md-mocgor library is responsible for verifying links from a Markdown file, showing statistical reports of total, broken or invalid links.
For the installation of this library it will be necessary to execute the following command line in your terminal
npm i md-mocgor
md-mocgor
md-mocgor --help
md-mocgor ./pruebas
md-mocgor ../routeFail
md-mocgor ./pruebas/prueba.md
md-mocgor ./pruebas --validate
md-mocgor ./pruebas --stats
md-mocgor ./pruebas --stats --validate
md-mocgor ./pruebas --validate --stats
md-mocgor ./pruebas --valida
- [ ] Puede instalarse via
npm install --global <github-user>/md-links
- [X] Un board con el backlog para la implementación de la librería.
- [X] Documentación técnica de la librería.
- [X] Guía de uso e instalación de la librería
- [X] El módulo exporta una función con la interfaz (API) esperada.
- [X] Implementa soporte para archivo individual
- [X] Implementa soporte para directorios
- [X] Implementa
options.validate
- [X] Expone ejecutable
md-links
en el path (configurado enpackage.json
) - [X] Se ejecuta sin errores / output esperado
- [X] Implementa
--validate
- [X] Implementa
--stats
- [X] Pruebas unitarias cubren un mínimo del 70% de statements, functions, lines, y branches.
- [X] Pasa tests (y linters) (
npm test
).