Md-links-ladypino NPM

Markdown Links

Índice

1. Introducción
2. Objetivos de aprendizaje
3. Guía de uso e instalación de la librería(#3-Guía de uso e instalación de la librería)
4. Instale la libreria via(#4-Instale la libreria via )
5. CLI
8. Javascripts API(#8-Javascripts API)
8. Argumentos
8. Ejemplos
8. Options

README.md

Introducción

Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchísimas plataformas que manejan texto plano (GitHub, foros, blogs, ...), y es muy común encontrar varios archivos en ese formato en cualquier tipo de repositorio (empezando por el tradicional README.md).

Estos archivos Markdown normalmente contienen links (vínculos/ligas) que muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de la información que se quiere compartir.

Node.js es un entorno de ejecución para JavaScript construido con el motor de JavaScript V8 de Chrome. Esto nos va a permitir ejecutar JavaScript en el entorno del sistema operativo, ya sea tu máquina o un servidor, lo cual nos abre las puertas para poder interactuar con el sistema en sí, archivos, redes, ...

md-links

Objetivos

El objetivo práctico de este proyecto fué crear mi propia librería (o biblioteca - library) en JavaScript, usando usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

En este proyecto nos alejamos un poco del navegador para construir un programa que se ejecute usando Node.js, donde aprenderemos sobre cómo interactuar con el sistema archivos, con el entorno (proceso, env, stdin/stdout/stderr), ...

Diagrama de flujo Diagrama de flujo

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

Instale la libreria via:

npm install LadyPino/SCL014-md-links

El módulo exporta una función con la interfaz (API) esperada. El módulo implementa soporte para archivo individual El módulo implementa soporte para directorios El módulo implementa validate y stats

CLI

Expone ejecutable md-links en el path (configurado en package.json)

Se ejecuta sin errores ./ output esperado.
El ejecutable implementa --validate.
El ejecutable implementa --stats.
El ejecutable implementa --validate y --stats juntos.

JavaScript API

El módulo se importa en otros scripts de Node.js y ofrece la siguiente interfaz:

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:

linkUrl: URL encontrada.
textVf: Texto que aparecía dentro del link ().
fileRoute: Ruta del archivo donde se encontró el link.
NumberVf: códigos que devuelve el servidor después de recibir una petición HTTP, y que identifica si todo ha ido bien o ha habido algún error.

Ejemplo

const mdLinks = require("md-links");

mdLinks("./some/example.md")
  .then(links => {
    // => [{ href, text, file }]
  })
  .catch(console.error);

mdLinks("./some/example.md", { validate: true })
  .then(links => {
    // => [{ href, text, file, status, ok }]
  })
  .catch(console.error);

mdLinks("./some/dir")
  .then(links => {
    // => [{ href, text, file }]
  })
  .catch(console.error);

Por ejemplo:

$ md-links ./some/example.md
./some/example.md http://algo.com/2/3/ Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html algún doc
./some/example.md http://google.com/ Google

El comportamiento por defecto no debe validar si las URLs responden ok o no, solo debe identificar el archivo markdown (a partir de la ruta que recibe como argumento), analizar el archivo Markdown e imprimir los links que vaya encontrando, junto con la ruta del archivo donde aparece y el texto que hay dentro del link (truncado a 50 caracteres).

Options

--validate. Si pasamos la opción --validate, el módulo debe hacer una petición HTTP para averiguar si el link funciona o no. Si el link resulta en una redirección a una URL que responde ok, entonces consideraremos el link como ok.

Por ejemplo:

$ md-13d99df067c1
./some/example.md http://algo.com/2/3/ ok 200 Link a algo
./some/example.md https://otra-cosa.net/algun-doc.html fail 404 algún doc
./some/example.md http://google.com/ ok 301 Google

Vemos que el output en este caso incluye la palabra ok o fail después de la URL, así como el status de la respuesta recibida a la petición HTTP a dicha URL.

--stats Si pasamos la opción --stats el output (salida) será un texto con estadísticas básicas sobre los links.

$ md-links ./some/example.md --stats
Total: 3
Unique: 3

También podemos combinar --stats y --validate para obtener estadísticas que necesiten de los resultados de la validación.

$ md-links ./some/example.md --stats --validate
Total: 3
Unique: 3
Broken: 1

Tutoriales / NodeSchool workshoppers Utilizados de guia

Recursos Utilizados de guia

fetch node-fetch

@infinitebrahmanuniverse/nolb-md-@everything-registry/sub-chunk-2146

0.2.0

3 years ago

0.1.0

3 years ago