Md-links tool checker

Md-links tool checker es una libreria de línea de comando (CLI) que facilita la lectura, análisis y generar reportes estadísticos de los enlaces contenidos en archivos de formato Markdown.

Esta herramienta permite:

• Proporcionar información básica sobre enlaces de los archivos .md
• Proporcionar información estadística sobre enlaces en archivos .md
• Validar enlaces que se encientran en los archivos .md
• Reportar links repetidos.

Tabla de contenido

• Instalación
• Guía de uso
• Diagrama de flujo
• Dependencias adoptadas
• Backlog
• Autor
• Fuente

1. Instalación

Puede instalar la libreria con el comando

  npm install @mialedev/md-links

Nota: También puedes instalar la librería con uso del comando npm i md-links

2. Guía de Uso.

Para usarlo en la terminal:

  md-links <path-to-file> [options]

Opciones.

No ingresar ninguna opción

Mostrará el texto, la URL y la ruta del archivo dónde el link fue encontrado

--help o -h

Mostrará una tabla de ayuda con comandos válidos con ejemplos para aplicarlos.

--validate --stats o -va -s

Mostrará estadísticas de los links totales, links únicos, y links rotos de los resultados de la validación.

--stats o -s

Mostrará estadísticas básicas sobre los links únicos como links totales y links únicos.

--validate o -va

Mostrará el texto, la URL, la ruta del archivo dónde el link fue encontrado y una respuesta para validar si el link funciona o no (generará un codigo de status y un mensaje "Ok" o "Fail")

3. Diagramas de Flujo

API JavaScript

CLI (Command Line Interface)

4. Dependencias Adoptadas

"cfonts": "^2.10.0",
"chalk": "^5.0.0",
"commander": "^9.0.0",
"gradient-string": "^2.0.0",
"nanospinner": "^1.0.0",
"node-fetch": "^3.2.0",
"nodemon": "^2.0.15",
"table": "^6.8.0"

5. Backlog

Presentación de Backlog que se llevó a cabo con el uso de GitHub Projects.

6. Autor

Mirian Arévalo ✨

7. Fuente

Repositorio de Laboratoria: Se encuentran todas las condiciones y herramientas a trabajar para el proyecto.