md-link-rebeca v1.0.5

Markdown Links

Este modulo fue diseñado para cumplir con el siguiente proposito como parte del Bootcamp de Laboratoria:

Crear una librería usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan .

El modulo recibe los siguientes argumentos:

Argumentos

• path: Ruta absoluta o relativa al archivo o directorio, donde se encuentra el archivo o archivos markdown.
• options:
  • validate: Verifica los links encontrados
  • stats: Devuelve el total de links encontrados

Valor de retorno

Retorna un array de objetos , donde cada objeto representa un link y contiene las siguientes propiedades:

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

• href: URL encontrada.

Instalación

Para instalar la dependencia en tu proyecto.

 npm install md-link-rebeca

Uso

• Require

const  mdLinks = require("md-link-rebeca");

// Caso 1 .- Ruta relativa sin opciones

mdLinks("./some/example.md")

.then(links  => {

//=> [{ href, text, file }]

})
.catch(console.error);

  
// Caso 2.- Ruta relativa con opcion (validate)

mdLinks("./some/example.md", "--validate")

.then(links  => {

// => [{ href, text, file, status, ok }]

})

.catch(console.error);

// Caso 3 .- Ruta relativa con opcion (stats)

mdLinks("./some/example.md", "--stats")

.then(links  => {

// => [{ href, text, file, status, ok }]

})

.catch(console.error);


  
// Caso 4 .- Ruta relativa de un directorio sin options

mdLinks("./some/dir")

.then(links  => {

// => [{ href, text, file }]

})

.catch(console.error);

  

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

Ruta relativa sin opciones :

$ mdLinks ./some/example.md
[ { file: './some/example.md',
    text: 'Leer un archivo',
    href: 'https://nodejs.org/api/fs.html#fs_fs_readfile_path_options_callback' },
  { file:'./some/example.md' ,
    text: 'Leer un directorio',
    href:'https://nodejs.or/api/fs.html#fs_fs_readdir_path_options_callback' }]

Ruta relativa con opcion validate:

$ mdLinks ./some/example.md --validate
[ { file: './some/example.md',
    text: 'Leer un archivo',
    href:'https://nodejs.org/api/fs.html#fs_fs_readfile_path_options_callback' ,
    status: 'ok' },
  { file:'./some/example.md' ,
    text: 'Leer un directorio',
    href:'https://nodejs.org/api/fs.html#fs_fs_readdir_path_options_callback' ,
    status: 'ok' }]

La opcion validate determina si se desea validar los links encontrados.

Ruta relativa con opcion stats :

$ mdLinks ./some/example.md --stats
Total : 2

La opción stats determina el numero de los links encontrados.

Ruta absoluta sin opciones :

$ mdLinks ./some/dir/ 
[ { file: './some/dir/',
    text: 'Leer un archivo',
    href:'https://nodejs.org/api/fs.html#fs_fs_readfile_path_options_callback' ,
    status: 'ok' },
  { file:'./some/dir/' ,
    text: 'Leer un directorio',
    href:'https://nodejs.org/api/fs.html#fs_fs_readdir_path_options_callback' ,
    status: 'ok' }]

Esta opcion permite encontrar todos los archivos Markdown en el directorio y encontrar sus links