raquelburgos-md-links v0.1.1

Markdown links

Índice

• 1. Resumen del proyecto
• 2. Planeación de sprints
• 3. Diagramas de flujo
• 4. Módulos del proyecto
• 5.Modo de uso
• 6.Pruebas unitarias
• 7. Checklist

1. Resumen del proyecto

Creación de una herramienta de línea de comando (CLI) así como una librería (o biblioteca - library) en JavaScript, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

2. Planeación de sprints

NT. No terminado durante ese sprint.

Sprint 1.

• Crear diagrama de flujo API
• Crear diagrama de flujo CLI
• Existe la ruta
• Es absoluta la ruta
• Convertir ruta relativa a absoluta
• Es directorio

Sprint 2.

Validaciones API.

• Leer directorio
• Es archivo .md
• Leer archivo .md

• Obtener links

Instalaciones

• Babel
• Jest
• Chalk

Sprint 3.

Validaciones API

• Petición HTTP para status de links (NT)
• Petición HTTP para status de links
• Calculo stats
• Calculo stats con status

  CLI

• path
• --validate
• --stats
• --validate --stats
• --help
• !path
• Colores con librería chalk

Instalaciones

• ESLINT

Sprint 4.

Test

• Función mdLinks

READ ME

• README

3. Diagramas de flujo

Para la planeación de este proyecto se realizaron dos diagramas de flujo, Uno de los procesos que debe realizar la API y otro de lo que debe realizar el CLI.

3. Como Realizar la Instalación

Para instalar el módulo, simplemente ejecuta el siguiente comando en la terminal:

$ npm install raquelburgos-md-links

4. Como Utilizarlo

CLI (Command Line Interface - Interfaz de Línea de Comando)

Para utilizar el paquete md-links desde la línea de comando, sigue estos pasos:

1. Abre la terminal.
2. Escribe el siguiente comando:

npx md-links <ruta> [opciones]

• <ruta>: la ruta del archivo que deseas evaluar.
• [opciones]: selecciona una de las siguientes opciones:

Opciones:

• --validate: realiza una petición HTTP para verificar si los enlaces funcionan o no.
• --stats: muestra estadísticas básicas sobre los enlaces.
• --validate --stats: muestra estadísticas de los enlaces y cuántos de ellos están rotos.

Asegúrate de reemplazar <ruta> por la ruta real de tu archivo Markdown. Esto te permitirá ejecutar el paquete md-links y obtener los resultados correspondientes en la terminal.

Con esta simple línea de comando --validate, el módulo realizará una verificación de los enlaces en tu archivo Markdown y te mostrará el estado de cada uno. De esta manera, podrás identificar aquellos enlaces que no funcionan correctamente y tomar las acciones necesarias para corregirlos.

Si deseas obtener estadísticas básicas sobre los enlaces en tu archivo Markdown, puedes utilizar la opción --stats. Esto te proporcionará información como la cantidad total de enlaces y la cantidad de enlaces únicos presentes en el archivo.

Si deseas obtener estadísticas más detalladas que incluyan el estado de los enlaces, puedes combinar las opciones --stats y --validate. Esto te mostrará cuántos enlaces están rotos o inválidos, brindándote una visión completa de la calidad de los enlaces en tu archivo.

5. Ejemplos de Uso

CLI (Command Line Interface - Interfaz de Línea de Comando)

npx md-links example.md --validate
npx md-links example.md --stats
npx md-links example.md --validate --stats 

¡Con esta herramienta, puedes verificar de forma sencilla y eficiente los enlaces en tus archivos Markdown y obtener valiosa información sobre ellos! Ya no tendrás que preocuparte por enlaces rotos o inválidos en tus documentos Markdown, ya que podrás identificarlos rápidamente.