code review #22
code review #22
Conversation
There was a problem hiding this comment.
Mariana, puedo observar que tu proyecto cumple con el requerimiento y eso habla bien de tu dedicación al proyecto, tengo algunas observaciones, la primera es complementar tu archivo README.md para agregar información sobre la librería, recuerda que el usuario nuevo no sabe como instalar tu librería, si agregas información(capturas de pantalla, videos de instalación, diagrama de flujo) el usuario final tendrá una mejor referencia, otra observación es el uso del testing, porque si tu proyecto siguiera creciendo no sabrías si tus funciones siguen sirviendo, recuerda que parte de lo que hace el testing es automatizar la comprobación de el funcionamiento de tu librería. veo implementadas buenas practicas lo cual habla de tu crecimiento.
.gitignore
Outdated
| @@ -0,0 +1 @@ | |||
| node_modules | |||
There was a problem hiding this comment.
Me agrada la exclusion de la carpeta node_modules/ agregaria la carpeta de assets y el archivo package-lock.json
| const colors = require('colors'); | ||
| const path = require('path'); | ||
| const fs = require('fs'); | ||
| const markdownLinkExtractor = require('markdown-link-extractor'); | ||
| const fetch = require('node-fetch'); |
| let inputDoc = process.argv[2]; | ||
| let options = process.argv[3]; | ||
|
|
||
| const validateArgvExist = (inputFile) => { |
There was a problem hiding this comment.
cuando el valor muta se implementa let
| const validateArgvExist = (inputFile) => { | |
| let validateArgvExist = (inputFile) => { |
| const readFiles = (inputFile) => { | ||
| fs.readFile(inputFile, 'utf8', (err, data) => { | ||
| if (err) { | ||
| console.log(err); |
There was a problem hiding this comment.
Esto se pudo ver mejor con una promesa
| console.log(err); | |
| (res=>{ | |
| then | |
| catch |
| const selectOption = async (inputFile) => { | ||
| let links = markdownLinkExtractor(inputFile); | ||
| switch (options) { | ||
| case '--validate': { | ||
| validateLinks(links); | ||
| break; | ||
| } | ||
| case '--stats': { | ||
| stats(links); | ||
| break; | ||
| } | ||
| case '--validate--stats': | ||
| case '--stats--validate': { | ||
| await stats(links); | ||
| await validateLinks(links); | ||
| break; | ||
| } | ||
| default: { | ||
| getLinks(links); | ||
| break; | ||
| } | ||
| } | ||
| }; |
There was a problem hiding this comment.
Me agrada el uso de la sentencia de control
| console.log('Broken Links: '.brightRed + brokenLinks.length); | ||
| } | ||
|
|
||
| validateArgvExist(inputDoc); |
There was a problem hiding this comment.
ten cuidado con la invocación
| validateArgvExist(inputDoc); | |
| validateArgvExist(inputDoc); |
prueba.md
Outdated
| @@ -0,0 +1,7 @@ | |||
| # Archivo de pruebas | |||
There was a problem hiding this comment.
este archivo juto con las imágenes deberían de ir en una carpeta especial llamada assets
| { | ||
| "name": "cdmx009-mdlinks", | ||
| "version": "1.0.0", | ||
| "description": "CDMX009 MDLinks Mariana Olimpia", |
There was a problem hiding this comment.
La descripción tiene que ser sobre el uso de la librería ademas tendría que estar en ingles
| "description": "CDMX009 MDLinks Mariana Olimpia", | |
| "description": "Library for read md files for validate and stats", |
prueba.txt
Outdated
| @@ -0,0 +1 @@ | |||
| TEXTO DE PRUEBA | |||
| @@ -0,0 +1,8 @@ | |||
| const { validateArgvExist, validateExt, readFiles, selectOption, getLinks, validateLinks, stats } = require('../app') | |||
There was a problem hiding this comment.
veo la invocación pero no la implementación
| const { validateArgvExist, validateExt, readFiles, selectOption, getLinks, validateLinks, stats } = require('../app') | |
| const { validateArgvExist, validateExt, readFiles, selectOption, getLinks, validateLinks, stats } = require('../app') |
No description provided.