Markdown Links
md-links003 es una librería que lee y analiza archivos en formato Markdown
, para verificar los links que contengan y reportar
algunas estadísticas.
Instalación
npm i --g md-links003
Uso (CLI)
md-links PATH --stats --validate
- Por ejemplo:
$ md-links ./some/example.mdruta: ./some/example.md, link: http://process.com/2/3/, texto: processruta: ./some/example.md, link: http://google.com/ texto: Google
md-links PATH --validate
$ md-links ./some/example.md --validate ó --statsruta: ./some/example.md, link: http://process.com/2/3/, ok, 200, texto: processruta: ./some/example.md, link: https://ppt.net/algun-doc.html, fail, 404, ppt
md-links PATH --stats
$ md-links ./some/example.md --stats ó --validateTotal: 3Unique: 3
md-links PATH --stats --validate
$ md-links ./some/example.md --stats --validateTotal: 3Unique: 3Broken: 1
Uso (API)
; ;
mdLinks(path, options)
Argumentos
path
: Ruta absoluta o relativa al archivo o directorio. Si la ruta pasada es relativa, debe resolverse como relativa al directorio desde donde se invoca node - current working directory).options
: Un objeto con las siguientes propiedades:validate
: Booleano que determina si se desea validar los links encontrados.
Valor de retorno
La función debe retornar una promesa (Promise
) que resuelva a un arreglo
(Array
) de objetos (Object
), 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
const mdLinks = ; ; ; ;
$ md-links ./some/example.md --statsTotal: 3Unique: 3
Flujograma
documentación técnica de la librería.
Metodología: Scrum
Duración: 3 semanas.
Recursos que se utilizaron
- Acerca de Node.js - Documentación oficial
- Node.js file system - Documentación oficial
- Node.js http.get - Documentación oficial
- Node.js y npm
- Asíncronía en js
- NPM
- Publicar packpage
- Crear módulos en Node.js
- Leer un archivo
- Leer un directorio
- Path
- Linea de comando CLI
⌨️ < LABORATORIA /> Sobre mi 😊