Markdown Links
Índice
1. Preámbulo
Es una librería que usando Node.js, lee y analiza archivos
en formato Markdown, para verificar los links que contengan y reportar
algunas estadísticas.
2. Resumen del proyecto
El proyecto contiene una herramienta de línea de comando (CLI) y una librería (o biblioteca - library) en JavaScript.
1) JavaScript API
mdLinks(path, options)
Argumentos
-
path: Ruta absoluta o relativa al archivo. (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.
-
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 :
-
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: Mensajefailen caso de fallo uoken caso de éxito.
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);
### 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:
```sh
$ 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/ GoogleEl 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 GoogleVemos 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: 3Tambié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: 13. Objetivos de aprendizaje
JavaScript
-
[ ] 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)
Node.js
-
[ ] 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)
Control de Versiones (Git y GitHub)
-
[ ] 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)
HTTP
-
[ ] Consulta o petición (request) y respuesta (response).
-
[ ] Códigos de status de HTTP