- 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 usado en plataformas de texto plano como GitHub, blogs y foros. Se propone crear una herramienta en Node.js para leer archivos Markdown, verificar los links que contienen y reportar estadísticas. Esto sería útil para detectar links rotos en proyectos o facturas digitales. La herramienta buscaría y validaría los links, generando informes sobre su validez. Así se mejoraría la calidad de la información compartida y se facilitaría la corrección de enlaces rotos.
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.
-
✔️ Diferenciar entre tipos de datos primitivos y no primitivos
-
✔️ Arrays (arreglos)
-
✔️ Objetos (key, value)
-
✔️ Uso de condicionales (if-else, switch, operador ternario, lógica booleana)
-
✔️ Funciones (params, args, return)
-
✔️ Recursión o recursividad
-
✔️ Módulos de CommonJS
-
✔️ Diferenciar entre expresiones (expressions) y sentencias (statements)
-
✔️ Callbacks
-
✔️ Promesas
-
✔️ Pruebas unitarias (unit tests)
-
✔️ Pruebas asíncronas
-
✔️ Uso de mocks y espías
-
✔️ Pruebas de compatibilidad en múltiples entornos de ejecución
-
✔️ Uso de linter (ESLINT)
-
✔️ Uso de identificadores descriptivos (Nomenclatura y Semántica)
-
✔️ Instalar y usar módulos con npm
-
✔️ Configuración de package.json
-
✔️ Configuración de npm-scripts
-
✔️ process (env, argv, stdin-stdout-stderr, exit-code)
-
✔️ File system (fs, path)
-
✔️ 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: Colaboración en Github (branches | forks | pull requests | code review | tags)
-
✔️ GitHub: Organización en Github (projects | issues | labels | milestones | releases)
-
✔️ Consulta o petición (request) y respuesta (response).
-
✔️ Códigos de status de HTTP
Cree una herramienta usando Node.js, que lee y analiza archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas.
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.
-
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 inplementación debe pasar estos tets.
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