md-mocgor
v0.1.0
Published
The Md-mocgor library is responsible for verifying links from a Markdown file
Downloads
3
Readme
Markdown Links 📂
1. Preamble
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.
2. Project summary
The Md-mocgor library is responsible for verifying links from a Markdown file, showing statistical reports of total, broken or invalid links.
3. Flowcharts
Flowcharts API
Flowcharts CLI
4. Installation
For the installation of this library it will be necessary to execute the following command line in your terminal
npm i md-mocgor
5. User guide
Welcome to Md-Links
md-mocgor
When you enter the command --help
md-mocgor --help
When you enter the path
md-mocgor ./pruebas
When you enter an invalid path
md-mocgor ../routeFail
When you enter a route that has no links
md-mocgor ./pruebas/prueba.md
When you enter a valid path with opcion --validate
md-mocgor ./pruebas --validate
When you enter a valid path with opcion --stats
md-mocgor ./pruebas --stats
When you enter a valid path with --stats --validate
md-mocgor ./pruebas --stats --validate
When you enter a valid path with --validate --stats
md-mocgor ./pruebas --validate --stats
When you enter a valid path with an invalid option
md-mocgor ./pruebas --valida
6. Checklist
General
- [ ] Puede instalarse via
npm install --global <github-user>/md-links
README.md
- [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
API mdLinks(path, opts)
- [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
CLI
- [X] Expone ejecutable
md-links
en el path (configurado enpackage.json
) - [X] Se ejecuta sin errores / output esperado
- [X] Implementa
--validate
- [X] Implementa
--stats
Pruebas / tests
- [X] Pruebas unitarias cubren un mínimo del 70% de statements, functions, lines, y branches.
- [X] Pasa tests (y linters) (
npm test
).