efyguevara / scl009-md-links

Proyecto 4 generación 9 de Laboratoria SCL - Track FE.

SG-MD-LINKS

Introducción

sg-md-links es un paquete analizador de url's que puede acceder a diferentes rutas especificadas por el usuario, y puede leer el contenido tanto de archivos como de directorios para entregar información de cada uno de los links encontrados.

Instalación

Para instalar el módulo sg-md-links se debe ejecutar el siguiente comando en la terminal:

    npm install sg-md-links

Diagrama de flujo:

Guía de uso:

    const md-links = require('sg-md-links'); 

Comandos

Leer un Archivo

    md-links [file]

Retorna:

---

    md-links [file] --validate

Retorna:

---

    md-links [file] --stats

Retorna:

---

    md-links [file] --validate --stats

Retorna:

---

Leer un directorio

    md-links [directory]

Retorna:

---

    md-links [directory] --validate

Retorna:

---

    md-links [directory] --stats

Retorna:

---

    md-links [directory] --validate --stats

Retorna:

Versión

• Versión: 1.0.1

Dependencias

• eslint: "^6.0.1",
• eslint-plugin-jest: "^22.7.1",
• filehound: "^1.17.0",
• jest: "^24.8.0",
• marked: "^0.6.2",
• node-fetch: "^1.0.0"

Para un uso óptimo se recomienda utilizar las siguientes versiones:

• node: v8.11.4
• npm: v6.9.0

---

Desarrollado por:

Stefany E. Guevara B.