markdown-find-links
Version:
Con esta librería podrás encontrar todos los links que contienen tus documentos markdown, además podrás validar si están rotos o no
453 lines (327 loc) • 17.6 kB
Markdown
# Markdown-find-links V 1.1.0
Esta librería encuentra todas las ligas dentro de cada archivo con extensión ".md" (markdown), dentro de la ruta de directorio proporcionada por el usuario. *markdown-find-links* se ejecuta en la línea de comandos [Bash](https://programminghistorian.org/es/lecciones/introduccion-a-bash).
### Librerías utilizadas
Implementa las librerías de node.js:
- fs
- path
- console
Y las librerías externas:
- [markdown-it](https://www.npmjs.com/package/markdown-it)
- [jsondom](https://www.npmjs.com/package/jsondom)
- [chalk](https://www.npmjs.com/search?q=chalk)
### Lenguaje utilizado
El código está escrito en lenguaje de [javascript](https://www.javascript.com/).
### Pruebas unitarias
Para las pruebas unitarias se utilizó [Jest](https://jestjs.io/).
## Instalación
Usando npm (una vez que ya has instalado node.js):
```
$ npm i markdown-find-links
```
## Ejemplos de uso en la Linea de Comandos Shell
Buscar solo las ligas del documento (o los documentos) markdown
```
# Ingresar el comando "mdLinks" + la ruta (que puede ser absoluta o relativa) del directorio a explorar:
mdLinks .\ruta\relativa
```
### Opciones
Validar las ligas que están en el o los documentos markdown
```
# Ingresar el comando "mdLinks" + la ruta (que puede ser absoluta o relativa) del directorio a explorar + "--validate"
mdLinks .\ruta\relativa --validate
```
Pedir las estadísticas de los ligas
```
# Ingresar el comando "mdLinks" + la ruta (que puede ser absoluta o relativa) del directorio a explorar + "--stats":
mdLinks .\ruta\relativa --stats
```
## BACKLOG
[Aquí](https://trello.com/b/EaLAZWgD/mdlinks) puedes observar el tablero Kanban que se siguió para realizar este proyecto.
## Diagrama de flujjo
A continuación se presenta el diagrama de flujo de la funcionalidad del proyecto presente.
-----------------------------------------------------------------
# Markdown Links
## Preámbulo
[Markdown](https://es.wikipedia.org/wiki/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](https://nodejs.org/), que lea y analice archivos
en formato `Markdown`, para verificar los links que contengan y reportar
algunas estadísticas.
## Introducción
[Node.js](https://nodejs.org/es/) es un entorno de ejecución para JavaScript
construido con el [motor de JavaScript V8 de Chrome](https://developers.google.com/v8/).
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 (_process_, _env_, _stdin/stdout/stderr_), ...
## Objetivos
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](https://nodejs.org/en/).
- [módulos (CommonJS)](https://nodejs.org/docs/latest-v0.10.x/api/modules.html).
- [file system](https://nodejs.org/api/fs.html).
- [path](https://nodejs.org/api/path.html).
- [http.get](https://nodejs.org/api/http.html#http_http_get_options_callback).
- [Parsing](https://en.wikipedia.org/wiki/Parsing).
- [markdown](https://daringfireball.net/projects/markdown/syntax).
- [CLI](https://www.proyectobyte.com/windows/simbolo-del-sistema/uso-la-interfaz-linea-comandos).
- [npm-scripts](https://docs.npmjs.com/misc/scripts).
- [semver](https://semver.org/).
## Consideraciones generales
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**.
## Parte obligatoria
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](https://jestjs.io/)
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](https://help.github.com/en/articles/about-project-boards) de github que te
ayudaran a organizar y priorizar su trabajo.
### Archivos del 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, ...)
- `.editorconfig` con configuración para editores de texto.
- `.eslintrc` con configuración para linter.
- `.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 implementación debe pasar estos test.
### JavaScript API
El módulo debe poder importarse en otros scripts de Node.js y debe ofrecer la
siguiente interfaz:
#### `mdLinks(path, options)`
##### Argumentos
- `path`: Ruta absoluta o relativa al archivo o directorio. Si la ruta pasada es
relativa, debe resolverse con respecto 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.
##### 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:
- `href`: URL encontrada.
- `text`: Texto que aparecía dentro del link (`<a>`).
- `file`: Ruta del archivo donde se encontró el link.
#### Ejemplo
```js
const mdLinks = require("md-links");
// Caso 1 .- Ruta relativa sin options
mdLinks("./some/example.md")
.then(links => {
// => [{ href, text, file }]
})
.catch(console.error);
// Caso .- Ruta relativa con option (validate)
mdLinks("./some/example.md", { validate: true })
.then(links => {
// => [{ href, text, file, status, ok }]
})
.catch(console.error);
// Caso 3 .- Ruta relativa de un directorio sin options
mdLinks("./some/dir")
.then(links => {
// => [{ href, text, file }]
})
.catch(console.error);
//PD: Pueden presentarse más casos.
```
### 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/ 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).
#### 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:
```sh
$ 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.
##### `--stats`
Si pasamos la opción `--stats` el output (salida) será un texto con estadísticas
básicas sobre los links.
```sh
$ 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.
```sh
$ md-links ./some/example.md --stats --validate
Total: 3
Unique: 3
Broken: 1
```
## Entregables
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.
## Hacker edition
- Puedes agregar la propiedad `line` a cada objeto `link` indicando en qué línea
del archivo se encontró el link.
- Puedes agregar más estadísticas.
- Integración continua con Travis o Circle CI.
## Evaluación
### Tech
| Habilidad |
| ---------------------- |
| **JavaScript** |
| Estilo |
| Nomenclatura/semántica |
| Funciones/modularidad |
| Estructuras de datos |
| Tests |
| **SCM** |
| Git |
| GitHub |
| **CS** |
| Lógica |
| Arquitectura |
### Habilidades Blandas
| Habilidad |
| ---------------------------------------------------------- |
| Planificación y organización |
| Autoaprendizaje |
| Solución de Problemas |
| Dar y recibir feedback |
| Adaptabilidad |
| Trabajo en equipo (trabajo colaborativo y responsabilidad) |
| Comunicación eficaz |
| Presentaciones |
Recuerda revisar la rúbrica y de acuerdo a tus alcances en proyectos anteriores busca tu crecimiento personal.
## Pistas / Tips
### FAQs
#### ¿Cómo hago para que mi módulo sea _instalable_ desde GitHub?
Para que el módulo sea instalable desde GitHub solo tiene que:
- Estar en un repo público de GitHub
- Contener un `package.json` válido
Con el comando `npm install githubname/reponame` podemos instalar directamente
desde GitHub. Ver [docs oficiales de `npm install` acá](https://docs.npmjs.com/cli/install).
Por ejemplo, el [`course-parser`](https://github.com/Laboratoria/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`.
### Sugerencias de implementación
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):
- Usando un _módulo_ como [markdown-it](https://github.com/markdown-it/markdown-it),
que nos devuelve un arreglo de _tokens_ que podemos recorrer para identificar
los links.
- Siguiendo otro camino completamente, podríamos usar
[expresiones regulares (`RegExp`)](https://developer.mozilla.org/es/docs/Web/JavaScript/Guide/Regular_Expressions).
- También podríamos usar una combinación de varios _módulos_ (podría ser válido
transformar el markdown a HTML usando algo como [marked](https://github.com/markedjs/marked)
y de ahí extraer los link con una librería de DOM como [JSDOM](https://github.com/jsdom/jsdom)
o [Cheerio](https://github.com/cheeriojs/cheerio) entre otras).
- Usando un _custom renderer_ de [marked](https://github.com/markedjs/marked)
(`new marked.Renderer()`).
No dudes en consultar a tus compañeras, coaches y/o el [foro de la comunidad](http://community.laboratoria.la/c/js)
si tienes dudas existenciales con respecto a estas decisiones. No existe una
"única" manera correcta :wink:
### Tutoriales / NodeSchool workshoppers
- [learnyounode](https://github.com/workshopper/learnyounode)
- [how-to-npm](https://github.com/workshopper/how-to-npm)
- [promise-it-wont-hurt](https://github.com/stevekane/promise-it-wont-hurt)
### Otros recursos
- [Acerca de Node.js - Documentación oficial](https://nodejs.org/es/about/)
- [Node.js file system - Documentación oficial](https://nodejs.org/api/fs.html)
- [Node.js http.get - Documentación oficial](https://nodejs.org/api/http.html#http_http_get_options_callback)
- [Node.js - Wikipedia](https://es.wikipedia.org/wiki/Node.js)
- [What exactly is Node.js? - freeCodeCamp](https://medium.freecodecamp.org/what-exactly-is-node-js-ae36e97449f5)
- [¿Qué es Node.js y para qué sirve? - drauta.com](https://www.drauta.com/que-es-nodejs-y-para-que-sirve)
- [¿Qué es Nodejs? Javascript en el Servidor - Fazt en YouTube](https://www.youtube.com/watch?v=WgSc1nv_4Gw)
- [¿Simplemente qué es Node.js? - IBM Developer Works, 2011](https://www.ibm.com/developerworks/ssa/opensource/library/os-nodejs/index.html)
- [Node.js y npm](https://www.genbeta.com/desarrollo/node-js-y-npm)
- [Módulos, librerías, paquetes, frameworks... ¿cuál es la diferencia?](http://community.laboratoria.la/t/modulos-librerias-paquetes-frameworks-cual-es-la-diferencia/175)
- [Asíncronía en js](https://carlosazaustre.com/manejando-la-asincronia-en-javascript/)
- [NPM](https://docs.npmjs.com/getting-started/what-is-npm)
- [Publicar packpage](https://docs.npmjs.com/getting-started/publishing-npm-packages)
- [Crear módulos en Node.js](https://docs.npmjs.com/getting-started/publishing-npm-packages)
- [Leer un archivo](https://nodejs.org/api/fs.html#fs_fs_readfile_path_options_callback)
- [Leer un directorio](https://nodejs.org/api/fs.html#fs_fs_readdir_path_options_callback)
- [Path](https://nodejs.org/api/path.html)
- [Linea de comando CLI](https://medium.com/netscape/a-guide-to-create-a-nodejs-command-line-package-c2166ad0452e)
## Checklist
### General
- [x] Puede instalarse via `npm install --global <github-user>/md-links`
### `README.md`
- [ ] Colocar el pseudo código o diagrama de flujo con el algoritmo que soluciona el problema.
- [x] Un board con el backlog para la implementación de la librería.
- [x] Documentación técnica de la librería.
- [x] Guía de uso e instalación de la librería
### API `mdLinks(path, opts)`
- [x] El módulo exporta una función con la interfaz (API) esperada.
- [ ] Implementa soporte para archivo individual
- [x] Implementa soporte para directorios
- [x] Implementa `options.validate`
### Pruebas / tests
- [ ] Pruebas unitarias cubren un mínimo del 70% de statements, functions,
lines, y branches.
- [ ] Pasa tests (y linters) (`npm test`).
### CLI
- [x] Expone ejecutable `md-links` en el path (configurado en `package.json`)
- [x] Se ejecuta sin errores / output esperado
- [x] Implementa `--validate`
- [x] Implementa `--stats`
## Hacker Edition
- [ ] Crear un script en el package.json que transforme el codigo ES6+ a ES5.
- [ ] Puedes agregar la propiedad line a cada objeto link indicando en qué línea del archivo se encontró el link.
- [ ] Puedes agregar más estadísticas.
- [ ] Integración continua con Travis o Circle CI.