yessve-md-links v0.1.0

Markdown Links

Índice

• Markdown Links
  • Índice
  • 1. Preámbulo
  • 2. Resumen del proyecto
  • 3. Ejecución
  • 4. ¿Qué incluye la librería?
    • 1) JavaScript API
      • mdLinks(path, options)
        • Argumentos
        • Valor de retorno
      • Ejemplo (resultados como comentarios)
    • 2) CLI (Command Line Interface - Interfaz de Línea de Comando)
      • Options
        • --validate
        • --stats
  • 5. Instalación

1. Preámbulo

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.

Dentro de una comunidad de código abierto, nos han propuesto crear una herramienta usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

2. Resumen del proyecto

Node.js es un entorno de ejecución para JavaScript construido con el motor de JavaScript V8 de Chrome. Esto nos va a permitir ejecutar JavaScript en el entorno del sistema operativo, ya sea tu máquina o un servidor, lo cual nos abre las puertas para poder interactuar con el sistema en sí, archivos, redes, ...

En este proyecto nos alejamos un poco del navegador para construir un programa, específicamente crear una herramienta de línea de comando (CLI) así como una librería en JavaScript, que se ejecute usando Node.js, donde se interactúa con el sistema archivos, con el entorno (proceso, env, stdin/stdout/stderr), ...

3. Ejecución

El plan de trabajo incluye dos diagramas de flujo. Ellos, muestran las actividades para la construcción del API y de la línea de comando (CLI).

• Diagrama de flujo del API
• Diagrama del CLI

4. ¿Qué incluye la librería?

Este proyecto consta de dos partes listadas aquí

1) JavaScript API

El módulo se puede importar en otros scripts de Node.js y ofrece la siguiente interfaz:

mdLinks(path, options)

Argumentos

• path: Ruta absoluta o relativa al archivo o directorio. Si la ruta pasada es relativa, se resuelve como relativa al directorio desde donde se invoca node - current working directory).
• options: Un objeto con únicamente la siguiente propiedad:
  • validate: Booleano que determina si se desea validar los links encontrados. Éste será igual a true.

Valor de retorno

La función retorna una promesa (Promise) y resuelve un arreglo (Array) de objetos (Object), donde cada objeto representa un link y contiene las siguientes propiedades:

• href: URL encontrada.
• text: Texto que aparecía dentro del link (<a>).
• file: Ruta del archivo donde se encontró el link.

Ejemplo (resultados como comentarios)

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

mdLinks("./some/example.md")
  .then(links => {
    // => [{ href, text, file }]
  })
  .catch(console.error);

mdLinks("./some/example.md", { validate: true })
  .then(links => {
    // => [{ href, text, file, status, ok }]
  })
  .catch(console.error);

mdLinks("./some/dir")
  .then(links => {
    // => [{ href, text, file }]
  })
  .catch(console.error);

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

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

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

Por ejemplo:

El comportamiento por defecto identifica el archivo markdown (a partir de la ruta que recibe como argumento), analiza el archivo Markdown e imprime los links que vaya encontrando, junto con la ruta del archivo donde aparece y el texto que hay dentro del link.

Options

--validate

Si se pasa la opción --validate, el módulo hace 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:

Vemos que el output en este caso incluye la palabra ok o fail después de la URL, así como el status de la respuesta recibida a la petición HTTP a dicha URL.

--stats

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

También podemos combinar --stats y --validate para obtener estadísticas que necesiten de los resultados de la validación.

5. Instalación

Módulo instalable via npm install <github-user>/md-links. Este módulo incluye tanto un ejecutable como una interfaz que podamos importar con require para usarlo programáticamente.