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.
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, ...
En este proyecto nos alejamos un poco del navegador para construir un programa que se ejecute usando Node.js, donde aprenderemos sobre cómo interactuar con el sistema archivos, con el entorno (proceso, env, stdin/stdout/stderr), ...
El objetivo práctico de este proyecto es que aprendas cómo crear tu propia librería (o biblioteca - library) en JavaScript.
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.
Tópicos:
- Node.js.
- módulos (CommonJS).
- file system.
- path.
- http.get.
- Parsing.
- markdown.
- CLI.
- npm-scripts.
- semver.
Este proyecto se debe "resolver" de manera individual.
La librería debe estar implementada en JavaScript para ser ejecutada con Node.js. Está permitido usar librerías externas.
Tu módulo debe ser instalable via npm install <github-user>/md-links
. Este
módulo debe incluir tanto un ejecutable que podamos invocar en la línea de
comando como una interfaz que podamos importar con require
para usarlo
programáticamente.
Los tests unitarios deben cubrir un mínimo del 70% de statements, functions, lines y branches. Te recomendamos explorar Jest para tus pruebas unitarias.
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.
También te sugerimos que empieces a utilizar los project boards de github que te ayudaran a organizar y priorizar su trabajo.
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, ...).editorconfig
con configuración para editores de texto. Este archivo no se debe cambiar..eslintrc
con configuración para linter. Este archivo no se debe cambiar..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 las siguientes propiedades:validate
: Booleano que determina si se desea validar los links encontrados.