Git Product home page Git Product logo

cdmx-2018-01-fe-markdown's Introduction

Gloria Rivera

Portafolio

cdmx-2018-01-fe-markdown's People

Contributors

danielalab avatar developervilchez avatar diegovelezg avatar fabianbravoa avatar gloryarz avatar nerdale avatar

Watchers

 avatar

cdmx-2018-01-fe-markdown's Issues

VALORES DE RETORNO

  • Retorna Promesa
  • Es un arreglo de objetos
  • Cada objeto contiene link, texto del link, ruta del archivo del link

PATH

  • Acepta ruta absoluta o relativa
  • Si es relativa, debe resolverse como relativa al directorio desde donde se invoca node - currentworking directory).

Comentarios sobre MDLinks

Hola, tengo algunos comentarios.

  • En to código, al hacer referencia a tu variables "global" const filepath así yo ponga el URL no lo puedo ejecutar, tuve que hacer algunas modificaciones sino lanza los errores No es un archivo .md o Hay un problema para leer tu archivo . Encontré que si bien isAnMDFile, que de pasó podría ser sólo isMDFile recibe como parámetro un filepath, en la línea de ejecución no le estas pasando qué filepath usar:
    https://github.com/gloryarz/cdmx-2018-01-FE-markdown/blob/master/app.js#L114

  • Lo mismo sucede con readMDFile.

  • No llega a mostrar las opciones que le das porque en esta línea

    const userValue = 'options';

    Defines que userValue siempre será options 1ero porque lo hiciste un const, y 2do porque no se modifica o se entrega de tu getOptions, y en ningún momento extrae las opciones de process.argv o algo similar.

  • Encontré 1 test, pero no llega a todo el coverage :'(

Feedback

Hola Glo:

Me gusto mucho que hayas realizado un test aunque sea, muchas felicidades por eso.
Tu codigo se lee/entiende muy bien.
Tal vez agregar comentarios seria bueno.
Tambien que padre que hiciste uso de los issues.

Felicidades Glo, sigue esforzándote.

Requerimientos del readme

  • Descripción general de la librería.
  • Instrucciones de instalación.
  • Versiones de la librería.
  • Documentación de la Librería (Features, link de Demo, test, etc...).
  • Ejemplos (snippets) de uso.

OPTIONS

VALIDATE

  • Valida los links encontrados en el archivo (Booleano)

STATS

  • Calcula los links encontrados en el archivo (Booleano)

Feedback de código y estructura general

Gloria:
El acomodo de tus archivos esta bien, sin embargo recuerda que es importante generar carpetas que contengan a los mismos, esto ayuda en la organización de tu proyecto.

Con respecto a tú código, note que no tiene comentarios, mi sugerencia es que los añadas, pues aunque algunos tienen el nivel técnico para entender lo que esta haciendo este, no todos lo entenderán por ello te pido que lo comentes.

Note que estás usando callbacks, lo cuál es excelente pues así poco a poco irás entendiendo este tema.

En la mayoría de las funciones el forEach está presente, por lo cual sería un tema que tendrías que mejorar, ya que se repite varias veces a lo largo del mismo.

El for usado en la línea 103 es bien utilizado, sin embargo te sugiero lo cambies por otro tipo de iterador, ya que este a la larga es difícil de sustentar.

Falta unificar el código para que este te permita llamarlo desde la linea de comandos como mdLinks y pueda ejecutarse.

Excelente alcance, muchas felicidades.

Requerimientos generales

  • Módulo instalable
  • Archivo ejecutable
  • Se importa con require
  • Tests (70% statements, functions, lines, branches)

Feedback de código

Querida Glo,

Me encantó cómo estructuraste el código, leerlo fue sencillo y perfectamente Human Redable.

Me parece que tiene un orden claro, las funciones son específicas para cada tarea y como comentario sólo tengo que, agregues comentarios. Creo que lo haría aún más claro y bonito. Felicidades por empezar a usar promesas, creo que fue un alcance muy bueno. 👍

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.