-
Notifications
You must be signed in to change notification settings - Fork 43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
validation was performed #30
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
node_modules/ | ||
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,355 +1,10 @@ | ||||||
# Markdown Links | ||||||
# Hola amiguitos | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Tus comentarios del readme tienen que ser más formales
Suggested change
|
||||||
## Haciendo pruebas de mdlinks | ||||||
|
||||||
## Preámbulo | ||||||
![link]("link") | ||||||
|
||||||
[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`). | ||||||
[runa](https://runahr.com/) | ||||||
|
||||||
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. | ||||||
[jessi](https://github.com/castillojessica) | ||||||
|
||||||
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. | ||||||
|
||||||
![md-links](https://user-images.githubusercontent.com/110297/42118443-b7a5f1f0-7bc8-11e8-96ad-9cc5593715a6.jpg) | ||||||
|
||||||
## 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 (_proceso_, _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, | ||||||
[markdown](https://daringfireball.net/projects/markdown/syntax), CLI, | ||||||
[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**. | ||||||
|
||||||
- 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_.**, ademas de pasar los test y el linter. Te recomendamos | ||||||
utilizar [Jest](https://jestjs.io/) para tus pruebas unitarias. | ||||||
|
||||||
- Para este proyecto no está permitido utilizar `async/await`. | ||||||
|
||||||
- Para este proyecto es opcional el uso de ES Modules `(import/export)`, en el | ||||||
caso optes utilizarlo deberas de crear un script de `build` en el `package.json` | ||||||
que transforme el código ES6+ a ES5 con ayuda de babel. | ||||||
|
||||||
## Criterios de aceptacion | ||||||
|
||||||
Estos son los criterios de lo que debe ocurrir para que se satisfagan | ||||||
las necesidades del usuario: | ||||||
|
||||||
- Instalar la libreria via `npm install --global <github-user>/md-links` | ||||||
|
||||||
### `README.md` | ||||||
|
||||||
- Encontrar el *pseudo codigo* o *diagrama de flujo* con el algoritmo que | ||||||
soluciona el problema. | ||||||
- Encontrar un board con el backlog para la implementación de la librería. | ||||||
- Encontrar la documentación técnica de la librería. | ||||||
- Encontrar la Guía de uso e instalación de la librería. | ||||||
|
||||||
### API `mdLinks(path, opts)` | ||||||
|
||||||
- El módulo exporta una función con la interfaz (API) esperada. | ||||||
- El módulo implementa soporte para archivo individual | ||||||
- El módulo implementa soporte para directorios | ||||||
- El módulo implementa `options.validate` | ||||||
|
||||||
### CLI | ||||||
|
||||||
- Expone ejecutable `md-links` en el path (configurado en `package.json`) | ||||||
- Se ejecuta sin errores / output esperado. | ||||||
- El ejecutable implementa `--validate`. | ||||||
- El ejecutable implementa `--stats`. | ||||||
- El ejecutable implementa `--validate` y `--stats` juntos. | ||||||
|
||||||
|
||||||
Para comenzar este proyecto tendrás que hacer un _fork_ y _clonar_ este | ||||||
repositorio. | ||||||
|
||||||
Antes de comenzar a codear, es necesario que pensemos en la arquitectura y | ||||||
boilerplate del proyecto, por lo que `antes de que empieces tu planificacion | ||||||
y a trabajar en la funcionalidad de tu proyecto deberás de haber | ||||||
creado tu boilerplate y tus tests`. Esto debería quedar | ||||||
detallado en tu repo y haberte asegurado de haber recibido feedback de uno | ||||||
de tus coaches. Una vez hayas terminado de definir la arquitectura y los tests | ||||||
de tu proyecto estarás lista para iniciar con tu **planificacion** por lo cual | ||||||
deberas de hacer uso de una serie de _issues_ y _milestones_ para priorizar | ||||||
tus tareas y crear un _project_ para organizar el trabajo y poder hacer | ||||||
seguimiento de tu progreso. | ||||||
|
||||||
Dentro de cada _milestone_ se crearán y asignarán los _issues_ que cada quien | ||||||
considere necesarios. | ||||||
|
||||||
### 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 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. | ||||||
|
||||||
##### 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"); | ||||||
|
||||||
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); | ||||||
``` | ||||||
|
||||||
### 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: | ||||||
|
||||||
```sh13d99df067c1 | ||||||
$ md-13d99df067c1 | ||||||
./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. | ||||||
|
||||||
## Objetivos de aprendizaje | ||||||
|
||||||
Recuerda colocar en esta seccion los objetivos de aprendizaje que quedaron | ||||||
pendientes de tu proyecto anterior. | ||||||
|
||||||
### Javascript | ||||||
- [ ] Uso de callbacks | ||||||
- [ ] Consumo de Promesas | ||||||
- [ ] Creacion de Promesas | ||||||
- [ ] Modulos de Js | ||||||
- [ ] Recursión | ||||||
|
||||||
### Node | ||||||
- [ ] Sistema de archivos | ||||||
- [ ] package.json | ||||||
- [ ] crear modules | ||||||
- [ ] Instalar y usar modules | ||||||
- [ ] npm scripts | ||||||
- [ ] CLI (Command Line Interface - Interfaz de Línea de Comando) | ||||||
|
||||||
### Testing | ||||||
- [ ] Testeo de tus funciones | ||||||
- [ ] Testeo asíncrono | ||||||
- [ ] Uso de librerias de Mock | ||||||
- [ ] Mocks manuales | ||||||
- [ ] Testeo para multiples Sistemas Operativos | ||||||
|
||||||
### Git y Github | ||||||
- [ ] Organización en Github | ||||||
|
||||||
### Buenas prácticas de desarrollo | ||||||
- [ ] Modularización | ||||||
- [ ] Nomenclatura / Semántica | ||||||
- [ ] Linting | ||||||
|
||||||
*** | ||||||
|
||||||
## 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) | ||||||
- [Promise](https://javascript.info/promise-basics) | ||||||
- [Comprendiendo Promesas en Js](https://hackernoon.com/understanding-promises-in-javascript-13d99df067c1) | ||||||
- [Pill de recursión - video](https://www.youtube.com/watch?v=lPPgY3HLlhQ&t=916s) | ||||||
- [Pill de recursión - repositorio](https://github.com/merunga/pildora-recursion) | ||||||
[Modificación de link](https://www.youtube.com/wach?v=fBNz5xF-Kx488) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. recomiendo que tu Readme tenga recursos para el usuario final y el propósito de estos recursos sea ayudar en la instalación de la librería y tener una mejor documentación |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Esta genial discriminar la carpeta node_modules/ te recomiendo excluir el archivo package-lock.json