search

KneRodri / DEV010-md-links

0 stars 0 forks source link

Proyecto MD-Links #14

Closed KneRodri closed 10 months ago

KneRodri commented 11 months ago

Este proyecto desarrollaré una librería en Node para analizar links en MD.

Markdown es un lenguaje de marcado ligero, esto quiere decir que es un formato de texto que ocupa poco espacio y es fácil de editar.

En MD normalmente contiene links que muchas veces están rotos o ya no son válidos.

Crear una herramienta usando Node, que lea y analice archivos en formatos Markdown, para verificar los link y reportar algunas estadísticas.

Estará disponible como módulo publicado en GitHub, que se pueda instalar e importar y como una interfaz de línea de comandos ( CLI ) que permitirá utilizar la librería desde la terminal.

Al finalizar se puede instalar la librería cómo NPM (node package manager)

https://github.com/KneRodri/DEV010-md-links

KneRodri commented 11 months ago

CONSIDERACIONES TÉCNICAS:

    Se utilizará GitHub Project como para priorizar y organizar.
    La librería y el script ejecutable (herramientas de línea de comando - CLI ) deben estar implementados en JS para ser 
    ejecutados en Node. Está permitido usar librerías externas.

    El módulo debe ser instalable vía npm install _<github-user/md-links_ . 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 test unitarios deben incluir un mínimo de 70 %.

    Utilizar los módulos CommanJS.

   Evitar el uso de las funciones sincrónicas _readFileSync_ para leer los archivos. En su lugar se recomienda de manera asíncrona usar _readFile_. Si se usa el módulo _fs/promises_, se podrá utilizar la versión promisificada de las funciones como _readFile_

  Para disminuir la complejidad del algoritmo recursivo, se recomienda utilizar la versión síncrona de la función para leer directorios, _readdicSync_