Mi md links Iris Trejo #28
Conversation
There was a problem hiding this comment.
Iris, me agrada que pudiste resolver tu proyecto y cumpliste con el requerimiento. Las observaciones que tengo son sobre la descripción del archivo README.md porque el usuario no tiene una guía practica de como opera la librería y como instalarla, mi sugerencia es completar con multimedia(capturas de pantalla ó videos) de la instalación, descripción y ejecución, por otro lado me percate que el uso de TESTING lo dejaste de lado, lo cual te recomiendo complementar testeando todas tus funciones faltantes con DATOS REALES, usar datos reales es muy útil, observe buenas practicas lo cual es importante resaltar.
| node_modules/ | ||
| .DS_Store |
There was a problem hiding this comment.
esta genial el excluir estas carpetas, añadiría la carpeta assets y package-lock.json
| @@ -0,0 +1,81 @@ | |||
| let fs = require('fs') | |||
There was a problem hiding this comment.
cuando las variable mutan(cambian su valor) se usa let, si no mutan se usa const
| let fs = require('fs') | |
| const fs = require('fs') |
| let fetch = require ('node-fetch') | ||
| let colors = require ("colors") |
There was a problem hiding this comment.
| let fetch = require ('node-fetch') | |
| let colors = require ("colors") | |
| const fetch = require ('node-fetch') | |
| const colors = require ("colors") |
|
|
||
|
|
||
| // read file | ||
| function readMd (uri){ |
There was a problem hiding this comment.
| function readMd (uri){ | |
| function readMd (file){ |
| // read file | ||
| function readMd (uri){ | ||
| let readString = fs.readFileSync(uri, 'utf-8') | ||
| return `${readString}` |
There was a problem hiding this comment.
| return `${readString}` | |
| return readString |
| { | ||
| "name": "CDMX009-MdLinks", | ||
| "version": "1.0.0", | ||
| "description": "## Preámbulo", |
There was a problem hiding this comment.
tu descripción tiene que ser funcional y en ingles
| "description": "## Preámbulo", | |
| "description": "## Preámbulo", |
| @@ -0,0 +1,11 @@ | |||
| const { readMd } = require('../index'); | |||
|
|
|||
| describe('test de funcion 1', () => { | |||
There was a problem hiding this comment.
| describe('test de funcion 1', () => { | |
| describe('function testing one', () => { |
| const { readMd } = require('../index'); | ||
|
|
||
| describe('test de funcion 1', () => { | ||
| test('espero que mi funcion 1 sea una funcion', () => { |
There was a problem hiding this comment.
ingles
| test('espero que mi funcion 1 sea una funcion', () => { | |
| test('function one response function', () => { |
| expect(typeof readMd).toBe('function') | ||
| }) | ||
| }) | ||
| it('Se espera leer un archivo de lectura',() => { |
There was a problem hiding this comment.
recomiendo ser más puntual en la descripción
| it('Se espera leer un archivo de lectura',() => { | ||
| let uri = './otraCosa.md' | ||
| expect(typeof readMd(uri)).toBe('string') | ||
| }) |
There was a problem hiding this comment.
El testing es importante, te recomiendo hacer testing de todas tus funciones
No description provided.