ysisc-md-links v1.0.3

Markdown Links

Índice

• 1. Acerca de MD-Links
• 2. Como instalar md-links
• 3. Implementacion de uso
• 4. Diagrama de flujo
• 5. Checklist

1. ACERCA DE MDLINKS

Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchísimas plataformas que manejan texto plano (GitHub, foros, blogs, ...) y es muy común encontrar varios archivos en ese formato en cualquier tipo de repositorio (empezando por el tradicional README.md).

Estos archivos Markdown normalmente contienen links (vínculos/ligas) que muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de la información que se quiere compartir.

Dentro de una comunidad de código abierto, nos han propuesto crear una herramienta usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

2.COMO INSTALAR MD LINKS

npm i ysisc-md-links

3. Implementacion de uso

Si necesitas ayuda:

md-links <path> --help

En caso de necesitar los links

md-links <path> --validate

En caso de necesitar los links totales exitoso y rotos

md-links <path> --validate --stats

En caso de necesitar los links totales exitoso

md-links <path> --stats

4. Diagrama de flujo

Diagrama de MD-LINKS

Diagrama de CLI

5. Checklist

General

• 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).