@carolgmonteiro/md-links v1.0.0

Md-Links | Libreria para extraer links de archivos Markdown

Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchas 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.

La libreria, que está en el idioma inglés, fue creada usando Node.js, e su función es leer y analizar archivos en formato Markdown desde el input de un unico archivo hasta un directorio. Extrae links de los archivos y los verifica el status de los links y saca estadísticas cómo total de links, links que no funcionan y unicos.

Guía de Uso e Instalación

Instalación

const mdLinks = require("cgm-md-links");

Con el comando npm install cgm-md-links podemos instalar directamente. Ver docs oficiales de npm install acá.

npm install cgm-md-links

Como usar

En el archivo JS:

const mdlinks = require("cgm-md-links");

Cómo llamar a libreria desde la terminal:

• Para path-to-file igual a un Directorio

md-links <"path-to-directory"> [options]

• Para path-to-file igual a un archivo

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

CLI (Command Line Interface)

La libreria hace las seguientes entregas:

1. El usuario no elije ninguna opción y recibe los links extraiedos de los archivos analizados

2. Elije las opciones disponibles:

• stats (dados estadisticos de los links)
• validate (status de los links en la red)
• stats validate (dados estadisticos del status de los links)

PATH

• Leer archivos con extensión .md

md-links <file.md>

• Leer un directorio

md-links <"path-to-directory">

En ambos casos, se obtiene como resultado:

• file: archivo o ruta donde fue encontrado el link.
• text: descripción del link.
• href: link encontrado.

OPTIONS

--validate

Entrega la validacion o status de los links (status: 200, 300, 404, 500 etc).

Usar así md-links <"path-to-file"> --stats

--stats

Entrega las seguientes estadísticas de los links: Total - el total de links encontrados; Unique - el total de links unicos.

Usar así md-links <"path-to-directory"> --stats --validate md-links <"path-to-file"> --stats --stats | --s

--stats --validate

Entrega las seguientes estadísticas de los links: Total - el total de links encontrados; Unique - el total de links unicos. Broken - el total de links rotos;

Usar así md-links <"path-to-directory"> --stats --validate md-links <"path-to-file"> --stats --validate --stats --validate | --validate --stats | --s --v | --v --s

Documentación técnica

Dependencias:

• node.js versión 11
• "chalk": "^2.4.2"
• "fetch": "^1.1.0"
• "filehound": "^1.17.3"
• "marked": "^0.7.0",
• "node-fetch": "^2.6.0"
• "eslint": "^6.2.1",
• "eslint-plugin-jest": "^22.15.2",
• "jest": "^24.9.0"

Planificación:

Diagrama de Flujo

Trello

El board con el backlog de la implementación de la librería puede ser encontrado aquí.

Milestones del proyecto

El proyecto fue ordenado en milestones en trello, recorriendo cada parte del diagrama de flujo

Autora

Carolina Guido Monteiro Desarrolladora Front-end