md-links-nelly-navarro v0.1.3

Markdown Links

Índice

1. Preámbulo
2. Resumen del proyecto
3. Objetivos de aprendizaje
4. Consideraciones generales
5. Criterios de aceptación mínimos del proyecto
6. Diagrama de flujo
7. Planificación
8. Antes de codear
9. Implementación
10. Checklist

1. Preámbulo

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.

Dentro de una comunidad de código abierto, nos han propuesto crear una herramienta usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.

2. Resumen del proyecto

En este proyecto se creo una herramienta de línea de comandos (Cli), así como la librería en JavaScript, un programa que se ejecute usando Node.js

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

3. OBJETIVOS DE APRENDIZAJE:

Node.js

• X Instalar y usar módulos con npm
• X Configuración de package.json
• X Configuración de npm-scripts
• X process (env, argv, stdin-stdout-stderr, exit-code)
• X File system (fs, path)

HTTP

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

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

• X Códigos de status de HTTP

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

4. Consideraciones generales

• El módulo es insatalable via npm install <github-user>/DEV007-md-links.

• Los tests unitarios deben cubren un mínimo del 70% de statements, functions, lines y branches.

• Para este proyecto se establece el uso de ES Modules (import/export).

5. Archivos del proyecto

• 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.
• index.js: Desde este archivo se exporta la 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. Este archivo no se debe cambiar.
• .eslintrc con configuración para linter. Este archivo contiene una configuración básica para ESLint.
• .gitignore ignora node_modules u otras carpetas que no deban incluirse en control de versiones (git).
• test/md-links.spec.js contiene los tests unitarios para la función mdLinks().

El módulo debe poder importarse en otros scripts de Node.js y debe ofrecer la siguiente interfaz:

mdLinks(path, options)

Argumentos

• path: Ruta absoluta o relativa al archivo Si la ruta pasada es relativa, debe resolverse como relativa.
• 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 resuelve 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

mdLinks("prueba.md")
  .then((pathIsAbsolute) => {
    console.log((pathIsAbsolute),6);
  })
  .catch((error) => {
    console.error((chalk.red("Error:", error)),6.1);
  });

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

El ejecutable de nuestra aplicación debe poder ejecutarse de la siguiente manera a través de la terminal:

node cli.js

Ejemplo de archivo con links:

Link de cinemark [cinemark](https://www.cinemark.cl/)

Link de película [cinemark movie](https://www.cinemark.cl/pelicula?corporate_film_id=93835)

Link roto [broken](https://www.cinemark.ccl/)

El comportamiento por defecto 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 .

6.- Diagrama de flujo

Para visualizar las tareas y objetivos, se llevó a cabo un diagrama de flujo.

Seguido de un pseudocódigo (representados por comentarios dentro del código)

7.- Planificación

En este proyecto para su planificación, tareas y objetivos utilizamos la herramienta de planificación Trello de primera instancia y utilizamos la herramienta de organización de GitHub llamada Github Projects, tambien para familiarizarse con ella.

8.-Antes de codear

• Nos aseguramos de comprender el proyecto.

• Se estudio previamente sobre NodeJS

• se decidió desde un comienzo la utilización de: ES Modules, es decir, import/export, en lugar de CommonJS Modules (require/module.exports).

• Se instalaron todas las paquetes a utilizar como Jest.js, axios, chalk, babel y EsLint.

9.-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:

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.

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

10.-Implementación

La implementación de este proyecto tiene varias partes: leer del sistema de archivos, recibir argumentos a través de la línea de comando, analizar texto, hacer consultas HTTP

• Se utilizó: expresiones regulares (RegExp).

11.-Checklist

General

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

API mdLinks(path, opts)

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

CLI

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

Pruebas / tests

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