Markdown Links

Índice

• 1. Preámbulo
• 2. Información del proyecto
• 3. Consideraciones Generales
• 4. Guía de Uso

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

• Diagrama de flujo API

• Diagrama de flujo CLI

3. Guía de Uso

JavaScript API

El módulo debe poder importarse en otros scripts de Node.js y debe ofrece la siguiente interfaz:

mdLinks(path, options)

Argumentos

• path: Ruta absoluta o relativa al archivo o directorio. Si la ruta pasada es relativa, debe resolverse 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.

  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);

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

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

$ npm install bitzyg-md-links

Valor de retorno

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

Con validate:false :

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

Con validate:true :

• href: URL encontrada.
• text: Texto que aparecía dentro del link (<a>).
• file: Ruta del archivo donde se encontró el link.
• status: Código de respuesta HTTP.
• ok: Mensaje fail en caso de fallo u ok en caso de éxito.

opciones

• Option md-links --help

• Options md-links <path-to-file> --stats --validate

• Options md-links <path-to-file> --validate --stats También podemos combinar --stats y --validate para obtener estadísticas que necesiten de los resultados de la validación.

  $ md-links ./some/example.md --stats --validate
  Total: 3
  Unique: 3
  Broken: 1

• Options md-links <path-to-file> --stats 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
  Total: 3
  Unique: 3

• Options md-links path --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 ./some/example.md --validate
  ./some/example.md http://algo.com/2/3/ ok 200 Link a algo
  ./some/example.md https://otra-cosa.net/algun-doc.html fail 404 algún doc
  ./some/example.md http://google.com/ ok 301 Google

  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.

• Error Path Cuanto de la ruta entregada no existe.

• Error No links Cuando el directorio/archivo no tiene links

4. Consideraciones generales

• La librería y el script ejecutable (herramienta de línea de comando - CLI) están implementados en JavaScript para ser ejecutados con Node.js.

• Este módulo es instalable via npm install <github-user>/md-links. Este módulo incluye tanto un ejecutable que podemos invocar en la línea de comando como una interfaz que podemos importar con require para usarlo programáticamente.

• Los tests unitarios deben cubrir un mínimo del 70% de statements, functions, lines y branches. Te recomendamos explorar Jest para tus pruebas unitarias.

• El comportamiento por defecto no debe validar si las URLs responden ok o no, solo debe identificar el archivo markdown (a partir de la ruta que recibe como argumento), analizar el archivo Markdown e imprimir los links que vaya encontrando, junto con la ruta del archivo donde aparece y el texto que hay dentro del link (truncado a 50 caracteres).