search

ElisabethContreras / DEV004-md-links

MdLinks
0 stars 0 forks source link

readme

Markdown Links

Índice

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. Por ejemplo en Laboratoria podrían usar esta herramienta para detectar los links rotos en los readmes de los proyectos o en un área de facturación verificar los links rotos de una factura dígital.

md-links

2. Resumen del proyecto

En este proyecto crearás una herramienta de línea de comando (CLI) así como tu propia librería (o biblioteca - library) en JavaScript.

En esta oportunidad nos alejamos del navegador para construir un programa que se ejecutará en la terminal usando Node.js. La forma en la que interactuaras con esta aplicación es mediante comandos que tu diseñaras/programaras por la terminal/shell. Aprenderemos sobre procesos (process.env, process.argv, ...), cómo interactuar con el sistema archivos, cómo hacer consultas/peticiones HTTP, etc.

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, ...

Diseñar tu propia librería es una experiencia fundamental para cualquier desarrollador porque que te obliga a pensar en la interfaz (API) de tus módulos y cómo será usado por otros developers. Debes tener especial consideración en peculiaridades del lenguaje, convenciones y buenas prácticas.

3. Objetivos de aprendizaje

Reflexiona y luego marca los objetivos que has llegado a entender y aplicar en tu proyecto. Piensa en eso al decidir tu estrategia de trabajo.

JavaScript

Node.js

Control de Versiones (Git y GitHub)

HTTP

4. Consideraciones generales

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

Para comenzar este proyecto tendrás que hacer un fork y clonar este repositorio.

Antes de comenzar a codear, es necesario crear un plan de acción. Esto debería quedar detallado en el README.md de tu repo y en una serie de issues y milestones para priorizar y organizar el trabajo, y para poder hacer seguimiento de tu progreso.

Dentro de cada milestone se crearán y asignarán los issues que cada quien considere necesarios.

Archivos del proyecto

Este proyecto consta de DOS partes

1) JavaScript API

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

mdLinks(path, options)

Argumentos
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 :

Con validate:true :

Ejemplo (resultados como comentarios)

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 nuestra aplicación debe poder ejecutarse 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 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-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

6. Entregables

Módulo instalable via npm install <github-user>/md-links. Este módulo debe incluir tanto un ejecutable como una interfaz que podamos importar con require para usarlo programáticamente.

7. Hacker edition

Las secciones llamadas Hacker Edition son opcionales. Si terminaste con todo lo anterior y te queda tiempo, intenta completarlas. Así podrás profundizar y/o ejercitar más sobre los objetivos de aprendizaje del proyecto.

8. Pistas, tips y lecturas complementarias

FAQs

¿Cómo hago para que mi módulo sea instalable desde GitHub?

Para que el módulo sea instalable desde GitHub solo tiene que:

Con el comando npm install githubname/reponame podemos instalar directamente desde GitHub. Ver docs oficiales de npm install acá.

Por ejemplo, el course-parser que usamos para la currícula no está publicado en el registro público de NPM, así que lo instalamos directamente desde GitHub con el comando npm install Laboratoria/course-parser.

Sugerencias de 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, ... y todas estas cosas pueden enfocarse de muchas formas, tanto usando librerías como implementando en VanillaJS.

Por poner un ejemplo, el parseado (análisis) del markdown para extraer los links podría plantearse de las siguientes maneras (todas válidas):

No dudes en consultar a tus compañeras y coaches si tienes dudas existenciales con respecto a estas decisiones. No existe una "única" manera correcta :wink:

Tutoriales / NodeSchool workshoppers

Otros recursos

9. Checklist

General

README.md

API mdLinks(path, opts)

CLI

Pruebas / tests

10. Achicando el problema

Un "superpoder" que esperamos puedas desarrollar durante el bootcamp es el de definir "mini-proyectos" que te acerquen paso a paso a la solución del "gran proyecto". Es el equivalente a comenzar armando esquinas o bordes del rompecabezas/puzzle sin saber necesariamente cómo encajarán al final. Déjate llevar y explora.

Estas son algunas sugerencias:

Empieza con un diagrama de flujo

Este proyecto es distinto de los que has venido trabajando hasta ahora dado que no hay una interfaz web, todo se desarrollará en tu editor y consola/terminal.

Es por ello que, para visualizar mejor lo que tendrás que hacer y planificar tus tareas y objetivos, es recomendable hacer un diagrama de flujo.

Si nunca has hecho un diagrama de flujo revisa este recurso.

Una alternativa al diagrama de flujo puede ser el pseudocódigo.

Planificación

En este proyecto te recomendamos usar la herramienta de planificación y organización de GitHub llamada Github Projects.

Mediante issues y milestones podrás organizar y planificar tareas y objetivos concretos.

Tomando en consideración los entregables del proyecto, el 9. Checklist y los pasos que definiste en tu diagrama de flujo, crea tu planificación en GitHub Projects.

Antes de codear

En esta ocasión estarás trabajando en NodeJS, asegúrate de saber para qué sirve y sus consideraciones.

En particular, deberás decidir desde un comienzo si usarás ES Modules, es decir, import/export, ó, por el contrario, CommonJS Modules, es decir, require/module.exports.

Asegurate de tener clara esta decisión desde un inicio para que no encuentres problemas más adelante.

Lee un archivo

Como primer reto, puedes tratar de leer un solo archivo con una ruta fija e imprimir su contenido en la consola con un console.log.

La librería nativa FS (FileSystem) te será de utilidad.

Recuerda: Te sugerimos no utilizar la versión síncrona de la función para leer archivos, readFileSync, y en cambio intentar resolver ese desafío de manera asíncrona.

Averigua la extensión de un archivo

Ya sabiendo leer un archivo, aventúrate a conocer cual es su extensión.

Recuerda, las extensiones son esas letras al final del nombre de un archivo, por ejemplo: .js, .txt, .doc, etc

Aquí también podrá ser útil FS.

Obtén el contenido de un directorio

Este proyecto consiste en buscar archivos, pero para eso, primero debes poder verlos.

Intenta imprimir en consola la lista de archivos en una carpeta.

La librería FS también te será útil aquí.

Recuerda: Para disminuir la complejidad de tu algoritmo recursivo, te recomendamos utilizar la versión síncrona de la función para leer directorios, readdirSync.

Une dos rutas

Para poder acceder a carpetas y archivos será necesario que indiques en qué lugar de tu computadora se encuentran, a esto le llamamos rutas.

Usa la librería nativa path para unir dos segmentos de ruta, por ejemplo, si queremos unir:

1) /home/Laboratoria/ 2) ./test

El resultado sería: /home/Laboratoria/test

Recursividad

Este proyecto se ha de resolver de forma casi natural con recursividad.

¿Por qué?.

Porque no conocemos realmente cuantas carpetas y archivos tendremos que recorrer antes de terminar.

Si recibes una ruta de carpeta, no sabrás de ante mano si dentro hay más carpetas o muchos archivos.

Por ello, asegurate bien de entender de qué trata la recursividad y ver algunos ejemplos.

Entre los recursos de este proyecto hay un video que te ayudará.

Crea una promesa

El valor de retorno de nuestra librería es una Promesa, no un Array.

Prueba leyendo sobre las promesas y creando una por tu cuenta utilizando new Promise()

Es importante que sepas qué es un callback pues las promesas los utilizarán.