gelenmr-md-links v0.1.1

md-Links - Libreria en npm

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.

Este modulo permite extraer links de archivos markdown(.md), validar su status y obtener algunas estadisticas de estos.

Guía de Uso e Instalación

Uso

const md-links = require ( 'gelenmr-md-links' ) ;   

Instalación

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

JavaScript API

El módulo puede importarse en otros scripts de Node.js mediante la siguiente interfaz: mdLinks(path, options)

Argumentos

• path: Ruta absoluta o relativa al archivo o directorio.
• options: puede ser una de las siguientes propiedades:
  • validate: Booleano que determina si se desea validar los links encontrados.
  • stats: Booleano que determina si se desea obtener un texto con estadísticas básicas sobre los links.

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

El ejecutable de nuestra aplicación puede ejecutarse de la siguiente manera a través de la terminal:

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

Por ejemplo:

$ md-links ./some/example.md
Links Encontrados: [
  {
  file: ./some/example.md,
  href: http://algo.com/2/3/, 
  text: Link a algo
  }
]

Si pasamos la opción --validate el output en este caso incluye la palabra ok o fail, así como el status de la respuesta recibida a la petición HTTP a dicha URL.

$ md-links ./some/example.md --validate
Links Encontrados: [
  {
  file: ./some/example.md,
  href: http://algo.com/2/3/,
  text: Link a algo,
  status: OK,
  code: 200
  }
]

Si pasamos la opción --stats el output (salida) será un texto con estadísticas básicas sobre los links.

$ md-links ./some/example.md --stats
Links Encontrados: { Total: 3, Unique: 3 }

Documentación técnica

Dependencias:

"chalk": "^2.4.2",
"eslint": "^6.0.0",
"filehound": "^1.17.0",
"marked": "^0.6.2",
"node-fetch": "^2.6.0"
"jest": "^24.8.0",

Planificación

Enlase a Planificacion del proyecto en trello

Recursos

• Acerca de Node.js - Documentación oficial
• What exactly is Node.js? - freeCodeCamp
• Node.js y npm
• Módulos, librerías, paquetes, frameworks... ¿cuál es la diferencia?
• NPM

Checklist

General

• Puede instalarse via npm install --global <github-user>/md-links

CLI

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

Autor: Gelen Montilla. Laboratoria 2019.