Puedes instalar con el comando npm i md-links-annmora13
- 1. Preámbulo
- 2. Resumen del proyecto
- 3. Objetivos de aprendizaje
- 4. Consideraciones generales
- 5. Criterios de aceptación mínimos del proyecto
- 6. Entregables
- 7. Hacker edition
- 8. Pistas, tips y lecturas complementarias
- 9. Checklist
- 10. Achicando el problema
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.
En este proyecto se creó una herramienta de línea de comando (CLI) así como mi propia librería (o biblioteca - library) en JavaScript.
Puedes instalar el programa con npm i md-links-annmora13 mientras entiendes el 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 debes exportar 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. Este archivo no se debe cambiar..eslintrc
con configuración para linter. Este archivo contiene una configuración básica para ESLint, si deseas agregar reglas adicionales como Airbnb deberás modificar este archivo..gitignore
para ignorarnode_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ónmdLinks()
. Tu implementación debe pasar estos tests.
El módulo debe poder importarse en otros scripts de Node.js y debe ofrecer la siguiente interfaz:
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.
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
: Mensajefail
en caso de fallo uok
en caso de éxito.
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);
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).
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.
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
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:
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
.
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.
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.
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.
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
.
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
.
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:
- /home/Laboratoria/
- ./test
El resultado sería: /home/Laboratoria/test
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á.
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.