ayauri29@mdlinks

Md-links es una librería que brinda estadísticas sobre los links que se encuentren dentro de todos los archivos .md de una ruta dada.

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

Instalación

Instale ayauri29@mdlinks desde npm.

npm i @ayauri29/md-links

Uso

API `mdLinks(path, opts)`

La función tiene 2 parámetros:

Path: Ruta absoluta o relativa al archivo o directorio.
Opts: Un objeto con las siguientes propiedades:
- validate: Booleano que determina si se desea validar los links encontrados.

El valor de retorno es una promesa (Promise) que resuelve un arreglo de objetos, 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

Importe ayauri29@mdlinks desde su proyecto.

const fn = require('ayauri29@mdlinks');

Para validación de los links:

mdLinks.mdLinks('src', {validate: true}).then((data) => console.log(data));

Para validate false:

const mdLinks = require('@ayauri29/md-links');
mdLinks.mdLinks('src', {validate: false}).then((data) => console.log(data));

CLI

Uso de comandos

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

El ejecutable implementa --validate.

El ejecutable implementa --stats.

El ejecutable implementa --validate y --stats juntos.

El ejecutable no implementa ninguna opción.

Para ayuda puede ejecutar el comando md-links --help

Objetivos de aprendizaje

Objetivos de aprendizaje pendientes

[x] Uso de callbacks

Javascript

[x] Consumo de Promesas
[x] Creacion de Promesas
[x] Modulos de Js
[x] Recursión

Node

[x] Sistema de archivos
[x] package.json
[x] crear modules
[x] Instalar y usar modules
[x] npm scripts
[x] CLI (Command Line Interface - Interfaz de Línea de Comando)

Testing

[x] Testeo de tus funciones
[x] Testeo asíncrono
[x] Uso de librerias de Mock
[x] Mocks manuales
[x] Testeo para multiples Sistemas Operativos

Git y Github

[x] Organización en Github

Buenas prácticas de desarrollo

[ ] Modularización
[ ] Nomenclatura / Semántica
[ ] Linting

Referencias

Current Tags

1.0.4 ... latest (a year ago)

2 Versions

1.0.4 ... a year ago
1.0.3 ... a year ago