LIM012-fe-md-links

Markdown Links

Objetivo alcanzado: La librería lee y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

Diagrama de flujo inicial

Documentación técnica de la librería

La funcionalidad principal de la librería es poder extraer los links de un archivo markdown.

Esto se puede lograr si el usuario proporciona una ruta a el o los archivos markdown que desee analizar. Estos links también pueden ser analizados mediante 2 opciones, “validate” y “stats”.

Instalación

• Instalar la libreria via npm install –global https://github.com/Rossevv/LIM012-fe-md-links/md-links
• Módulo instalable vía npm install r-mdlinks
• Este módulo incluye tanto un ejecutable como una interfaz que se puede importar como require para usarlo programáticamente.

r-mdLinks (path, options)

Argumentos

• path: Ruta absoluta o relativa al archivo o directorio.
• options: Un objeto con las siguientes propiedades:
• validate: { validate : true }

Valor de retorno

La función retorna los links, los cuales contienen 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

const mdLinks = require("r-mdlinks");

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

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

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

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

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

npx r-mdlinks <path-to-file> [options]

Por ejemplo:

$ r-mdlinks ./some/example.md
./some/example.md http://algo.com/2/3/ Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html algún doc
./some/example.md http://google.com/ Google

El comportamiento por defecto no valida si las URLs responden ok o no, solo identifica el archivo markdown, 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 (truncado a 50 caracteres).

Options

--validate

Si pasamos la opción --validate, el módulo hace una petición HTTP para averiguar si el link funciona o no.

Por ejemplo:

$ r-mdlinks ./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.

--stats

Si pasamos la opción --stats:

$ r-mdlinks ./some/example.md --stats
Total: 3
Unique: 3

También podemos combinar --stats y --validate:

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

Adicionalmente (help) --h

Si pasamos la opción --h el output (salida) es las opciones que el usuario puede ejecutar en la línea de comandos.

Guía de uso e instalación de la librería

Módulo instalable via npm install r-mdlinks. Este módulo incluye un ejecutable como una interfaz que se puede importar con require.

1.- En el terminal de tu proyecto: npm install r-mdlinks
2.- Puedes hacer importarlo mediante require (ver los ejemplos de arriba para más detalle)