Sj-mdlinks NPM

Markdown Links

Índice

Descripción

sj-mdlinks es una libreria que usa Node.js Contiene una función recursiva que recibe como parámetro una ruta, localiza todos los archivos con extensión .md que esten dentro de la ruta proporcionada (incluyendo subdirectorios), verifica los links que contenga cada archivo, valida su status (ok, fail) y calcula estadisticas básicas sobre los links (totales, únicos y rotos).

Homepage

Github StephanieJolianis

Diagrama de flujo

Instalación y uso (CLI)

Linux o MacOS

$ sudo npm i -g sj-mdlinks

Microsoft Windows

$ npm i -g sj-mdlinks

Ejecución de comandos:

Puedes ejecutar la aplicación de la siguiente manera a través de la terminal md-links options

Por ejemplo:

Para obtener links

Aquí puedes utilizar una ruta de un archivo con una extensión .md o una ruta de un directorio.

Comando:

$ mdlinks hola.md

Retorno:

[ { file: '/home/stephanie/Escritorio/pruebas-mdlinks/hola.md',
    href: 'https://www.npmjs.com/package/sj-mdlinks',
    text: 'Stephanie' },
  { file: '/home/stephanie/Escritorio/pruebas-mdlinks/hola.md',
    href: 'https://otra-cosa.net/algun-doc.html',
    text: 'Link roto' } ]

Options

`--validate`

Si pasas 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 se considera el link como ok.

Comando:

$ mdlinks hola.md --validate

Retorno:

[ { href: 'https://www.npmjs.com/package/sj-mdlinks',
    text: 'Stephanie',
    file: '/home/stephanie/Escritorio/pruebas-mdlinks/hola.md',
    code: 200,
    status: 'OK' },
  { href: 'https://otra-cosa.net/algun-doc.html',
    text: 'Link roto',
    file: '/home/stephanie/Escritorio/pruebas-mdlinks/hola.md',
    code: 404,
    status: 'FAIL' } ]

`--stats`

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

Comando:

$ mdlinks hola.md --stats

Retorno:

[ total: 2, unique: 2 ]

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

Comando:

$ mdlinks hola.md --validate --stats

Retorno:

[ total: 2, unique: 2, broken: 1, ok: 1 ]

Instalación y uso (MÓDULO)

Instalar como dependencia npm

$ npm i sj-mdlinks

Ejemplo uso del módulo

const mdlinks = require("sj-mdlinks");

//Obtener datos de un archivo .md [{ href, text, file }]
mdlinks("./some/example.md", { validate: false, stats: false})
  .then(links => {
    console.log(links)
  })
  .catch(console.error);

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

//Obtener estadísticas [{ total, unique }]
mdlinks("./some/example.md", { validate: false, stats: true })
  .then(links => {
    console.log(links)
  })
  .catch(console.error);

//Obtener estadísticas y validación de links [{ total, unique, broken, ok }]
mdlinks("./some/example.md", { validate: true, stats: true })
  .then(links => {
    console.log(links)
  })
  .catch(console.error);