Wondering what’s next for npm?Check out our public roadmap! »

@ayauri29/md-links

1.0.4 • Public • Published

ayauri29@mdlinks

Build Status Coverage Status npm dependents

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

image

Para validate false:

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

image

CLI

Uso de comandos
md-links <path-to-file> [options]
  • El ejecutable implementa --validate.

image

  • 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
  • Uso de callbacks
Javascript
  • Consumo de Promesas
  • Creacion de Promesas
  • Modulos de Js
  • Recursión

Node

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

Testing

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

Git y Github

  • Organización en Github

Buenas prácticas de desarrollo

  • Modularización
  • Nomenclatura / Semántica
  • Linting

Referencias

Install

npm i @ayauri29/md-links

DownloadsWeekly Downloads

1

Version

1.0.4

License

MIT

Unpacked Size

87.3 kB

Total Files

27

Last publish

Collaborators

  • avatar