/SCL018-md-links

dc-md-links es una herramienta de línea de comando (CLI), como también una librería en JavaScript, la cual lee un archivo con extensión md y retorna una array con los links que éste contiene. Además, puedes agregar la opción de validar estos links y recibir el estado de cada uno de ellos.

Primary LanguageJavaScript


¿Qué es dc-md-links?

dc-md-links es una herramienta de línea de comando (CLI), como también una librería en JavaScript, la cual lee un archivo con extensión md y retorna una array con los links que éste contiene. Además, puedes agregar la opción de validar estos links y recibir el estado de cada uno de ellos.


Instalación

npm install dc-md-links

¿Cómo usar?

En el archivo JS:

const mdlinks = require('dc-md-links');

En la terminal:

md-links < name-file > [options]

¿Cómo funciona en CLI (Command Line Interface - Interfaz de Línea de Comando)?

Ejecución a través de la terminal:

md-links <file> [options]

Por ejemplo:

$ md-links example.md 

El comportamiento por defecto debe identificar el archivo markdown, analizarlo e imprimir los links que vaya encontrando, junto con el tipo, texto y href.

Option validate

--validate

Si pasamos la opción --validate, el módulo debe hacer una petición HTTP para averiguar si el link funciona o no. Si el link resulta en una redirección a una URL que responde ok, entonces consideraremos el link como ok.

Por ejemplo:

$ md-links example.md --validate


Información técnica

Dependencias

  • node.js: 16.13.1
  • chalk: 5.0.0
  • figlet: 1.5.2
  • marked: 4.0.8
  • node-fetch: 3.1.0

Planificación


Autora

Daniela Castro Salazar