@raulingg/md-links
Advanced tools
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.
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 ignorar node_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ón
mdLinks(). 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:
mdLinks(path, options)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.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:
href: URL encontrada.text: Texto que aparecía dentro del link (<a>).file: Ruta del archivo donde se encontró el link.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).
--validateSi 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.
--statsSi 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
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.
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.
line a cada objeto link indicando en qué línea
del archivo se encontró el link.NOTA: Esta sección incluye una lista de habilidades que se podrán tener en cuenta a la hora de evaluar el proyecto. Los niveles esperados son sugerencias así como guías en el diseño curricular, pero no reglas absolutas.
Te aconsejamos revisar nuestra rúbrica para ver la descripción detallada de cada habilidad y cada nivel. Te recomendamos también que trates de aplicarte la rúbrica a tí misma y/o a los proyectos de tus compañeras a lo largo del Bootcamp para ir viendo tu evolución.
| Característica | Nivel esperado |
|---|---|
| Completitud | 4 |
Para este proyecto esperamos que ya hayas alcanzado el nivel 4 en todas tus habilidades blandas. Te aconsejamos revisar la rúbrica:
| Habilidad | Nivel esperado |
|---|---|
| Planificación y organización | 4 |
| Autoaprendizaje | 4 |
| Presentaciones | 4 |
| Adaptabilidad | 4 |
| Solución de problemas | 4 |
| Responsabilidad | 4 |
| Dar y recibir feedback | 4 |
| Comunicación eficaz | 4 |
| Habilidad | Nivel esperado |
|---|---|
| Computer Science | |
| Lógica | 2 |
| Arquitectura | 3 |
| Source Control Management | |
| Git | 3 |
| GitHub | 3 |
| JavaScript | |
| Estilo | 3 |
| Nomenclatura/semántica | 3 |
| Funciones/modularidad | 4 |
| Estructuras de datos | 3 |
| Tests | 3 |
Para que el módulo sea instalable desde GitHub solo tiene que:
package.json válidoCon 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.
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):
RegExp).new marked.Renderer()).No dudes en consultar a tus compañeras, coaches y/o el foro de la comunidad si tienes dudas existenciales con respecto a estas decisiones. No existe una "única" manera correcta :wink:
npm install --global <github-user>/md-linksREADME.mdmdLinks(path, opts)options.validatemd-links en el path (configurado en package.json)--validate--statsnpm test).FAQs
This library allows you to find links within markdown files
We found that @raulingg/md-links demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.
Security News
PyPI now allows maintainers to archive projects, improving security and helping users make informed decisions about their dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.