Markdown Links

1. MD-BEAR-LINKS

🐻 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-inks --help o md-links --h.

WITHOUT OPTIONS : md-links --validate o md-links --v.

VALIDATE OPTION : md-links --validate o md-links --v.

VALIDATE & STATS OPTION : md-links --validate --stats o md-links --v --s.

STATS OPTION : md-links --stats o md-links --s.

MANEJANDO ERRORES

Ruta no existe

Directorio vacio

No es archivo MD

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 🐻

8. Checklist

General

• [:bear: ] Puede instalarse via npm install --global <github-user>/md-links

README.md

• [ 🐻] Un board con el backlog para la implementación de la librería.
• [ 🐻 ] Documentación técnica de la librería.
• [ 🐻] Guía de uso e instalación de la librería

API mdLinks(path, opts)

• [ 🐻] El módulo exporta una función con la interfaz (API) esperada.
• [ 🐻] Implementa soporte para archivo individual
• [ 🐻] Implementa soporte para directorios
• [ 🐻] Implementa options.validate

CLI

• [ 🐻] Expone ejecutable md-links en el path (configurado en package.json)
• [ 🐻 ] Se ejecuta sin errores / output esperado
• [ 🐻] Implementa --validate
• [ 🐻] Implementa --stats

Pruebas / tests

• [ 🐻 ] Pruebas unitarias cubren un mínimo del 70% de statements, functions, lines, y branches.
• [ 🐻] Pasa tests (y linters) (npm test).