Markdown Links

1. Preámbulo

2. Resumen del proyecto

mdLinks es una herramienta de línea de comando de Javascript, ejecutada en NodeJS que se encarga de extraer y validar enlaces que se encuentren en archivos markdown. README.md con descripción del módulo, instrucciones de instalación/uso, documentación del API y ejemplos. Todo lo relevante para que cualquier developer que quiera usar tu librería pueda hacerlo sin inconvenientes.

3. Objetivos de aprendizaje

JavaScript

• Diferenciar entre tipos de datos primitivos y no primitivos

• Arrays (arreglos)

  Links

  • Arreglos
  • Array - MDN
  • Array.prototype.sort() - MDN
  • Array.prototype.forEach() - MDN
  • Array.prototype.map() - MDN
  • Array.prototype.filter() - MDN
  • Array.prototype.reduce() - MDN

• Objetos (key, value)

  Links

  • Objetos en JavaScript

• Uso de condicionales (if-else, switch, operador ternario, lógica booleana)

  Links

  • Estructuras condicionales y repetitivas
  • Tomando decisiones en tu código — condicionales - MDN

• Funciones (params, args, return)

  Links

  • Funciones (control de flujo)
  • Funciones clásicas
  • Arrow Functions
  • Funciones — bloques de código reutilizables - MDN

• Recursión o recursividad

  Links

  • Píldora recursión - YouTube Laboratoria Developers
  • Recursión o Recursividad - Laboratoria Developers en Medium

• Módulos de CommonJS

  Links

  • Modules: CommonJS modules - Node.js Docs

• Diferenciar entre expresiones (expressions) y sentencias (statements)

• Callbacks

  Links

  • Función Callback - MDN

• Promesas

  Links

  • Promise - MDN
  • How to Write a JavaScript Promise - freecodecamp (en inglés)

• Pruebas unitarias (unit tests)

  Links

  • Empezando con Jest - Documentación oficial

• Pruebas asíncronas

  Links

  • Tests de código asincrónico con Jest - Documentación oficial

• Uso de mocks y espías

  Links

  • Manual Mocks con Jest - Documentación oficial

• Pruebas de compatibilidad en múltiples entornos de ejecución

• Uso de linter (ESLINT)

• Uso de identificadores descriptivos (Nomenclatura y Semántica)

Node.js

• Instalar y usar módulos con npm

  Links

  • Sitio oficial de npm (en inglés)

• Configuración de package.json

  Links

  • package.json - Documentación oficial (en inglés)

• Configuración de npm-scripts

  Links

  • scripts - Documentación oficial (en inglés)

• process (env, argv, stdin-stdout-stderr, exit-code)

  Links

  • Process - Documentación oficial (en inglés)

• File system (fs, path)

  Links

  • File system - Documentación oficial (en inglés)
  • Path - Documentación oficial (en inglés)

Control de Versiones (Git y GitHub)

• Git: Instalación y configuración

• Git: Control de versiones con git (init, clone, add, commit, status, push, pull, remote)

• Git: Integración de cambios entre ramas (branch, checkout, fetch, merge, reset, rebase, tag)

• GitHub: Creación de cuenta y repos, configuración de llaves SSH

• GitHub: Despliegue con GitHub Pages

  Links

  • Sitio oficial de GitHub Pages

• GitHub: Colaboración en Github (branches | forks | pull requests | code review | tags)

• GitHub: Organización en Github (projects | issues | labels | milestones | releases)

HTTP

• Consulta o petición (request) y respuesta (response).

  Links

  • Generalidades del protocolo HTTP - MDN
  • Mensajes HTTP - MDN

• Codigos de status de HTTP

  Links

  • Códigos de estado de respuesta HTTP - MDN
  • The Complete Guide to Status Codes for Meaningful ReST APIs - dev.to

4. Consideraciones generales

• Este proyecto fue realizado por Danna Valentina Cárdenas de manera individual.

• La librería y el script ejecutable (herramienta de línea de comando - CLI) están implementados en JavaScript para ser ejecutados con Node.js. Se usó además la librería Axios para hacer las peticiones http.

• Tu módulo es instabale via npm install dannitazz/md-links. Este módulo debe incluye un ejecutable que se puede invocar en la línea de comando como una interfaz y se puede importar.

• Los tests unitarios etán escritos en Jest.

5. Criterios de aceptación mínimos del proyecto

El plan de acción para la realización de este proyecto consistió en realizar un diagrama de flujo que permitiera visualizar el flujo del programa, así se determinaron los issues y milestones, descritos inicialmente en Trello y luego llevados a GitHub Projects.

Archivos del proyecto

• index.js: Desde este archivo se exporta una función (mdLinks).
• package.json con nombre, versión, descripción, autores, licencia, dependencias, scripts (pretest, test, ...), main, bin
• .editorconfig con configuración para editores de texto.
• .eslintrc con configuración para linter. Este archivo contiene una configuración básica para ESLint.
• .gitignore para ignorar node_modules u otras carpetas que no deban incluirse en control de versiones (git).
• test/md-links.spec.js debe contener los tests unitarios para la función mdLinks().

Este proyecto consta de DOS partes

1) JavaScript 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 únicamente la siguiente propiedad:
  • 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

Con validate:false :

• href: URL encontrada.
• text: Texto que aparecía dentro del link (<a>).
• file: Ruta del archivo donde se encontró el link.

Con validate:true :

• href: URL encontrada.
• text: Texto que aparecía dentro del link (<a>).
• file: Ruta del archivo donde se encontró el link.
• status: Código de respuesta HTTP.
• ok: Mensaje fail en caso de fallo u ok en caso de éxito.

Ejemplo (resultados como comentarios)

// Modificar los ejemplos

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

2) CLI (Command Line Interface - Interfaz de Línea de Comando)

El ejecutable de la aplicación se ejecuta de la siguiente manera a través de la terminal:

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

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 identifica el archivo markdown (a partir de la ruta que recibe como argumento), analiza el archivo Markdown e imprime los links que vaya encontrando, junto con la ruta del archivo donde aparece y el texto que hay dentro del link.

Options

--validate

Si se pasa la opción --validate, el módulo hace 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-links ./some/example.md --validate
./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

9. Checklist

General

• Puede instalarse via npm install --global <github-user>/md-links

README.md

• Un board con el backlog para la implementación de la librería.
• Documentación técnica de la librería.
• Guía de uso e instalación de la librería

API mdLinks(path, opts)

• El módulo exporta una función con la interfaz (API) esperada.
• Implementa soporte para archivo individual
• Implementa soporte para directorios
• Implementa options.validate

CLI

• Expone ejecutable md-links en el path (configurado en package.json)
• Se ejecuta sin errores / output esperado
• Implementa --validate
• Implementa --stats

Pruebas / tests

• Pruebas unitarias cubren un mínimo del 70% de statements, functions, lines, y branches.
• Pasa tests (y linters) (npm test).