List view
HITO 4: - Interfaz de Línea de Comando (CLI) En este hito, crearás un Interfaz de Linea de Comando (CLI), un script ejecutable que internamente ejecutará la función mdLinks que acabas de crear. Este módulo debe incluir tanto un ejecutable que podamos invocar en la línea de comando como una interfaz que podamos importar para usarlo programáticamente. El ejecutable de tu aplicación debe poder correr de la siguiente manera a través de la terminal: `md-links <path-to-file> [options]` Por ejemplo: mdlinks-example 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: mdlinks-example-validate 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. mdlinks-example-stats También podemos combinar --validate y --stats para obtener estadísticas que necesiten de los resultados de la validación. mdlinks-example-stats-validate Para ejecutar tu script utilizando el comando mdlinks, debes vincular este comando al sistema. Sin embargo, antes de vincular el comando, puedes desarrollar tu interfaz de línea de comandos (CLI) invocándola con node. Por ejemplo, puedes usar el siguiente comando: node <RUTA_DE_TU_CLI.js> ruta options Este paquete deberá estar documentado en un repositorio público con un package.json para poderlo instalar con NPM. La instalación sería de la siguiente manera: npm install `<github-user>/md-links`.
No due date•2/2 issues closedHITO 2: Javascript API con segundo parámetro opcional "validate" Agrega un parámetro más a la función mdLinks que se llamará validate y que recibirá un valor booleano. validate será un argumento opcional. Ahora la función deberá ofrecer la siguiente interfaz: mdLinks(path, validate) 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 (transformar a absoluta). validate: Booleano que determina si se desea validar los links encontrados. Valor que resuelve la promesa con validate = false ó undefined: Un arreglo con objetos que representan links. Cada objeto tiene las propiedades: href: URL encontrada. text: Texto que aparecía dentro del link (<a>). file: Ruta del archivo donde se encontró el link. Recuerda que el valor anterior es el mismo que el del hito 1 Valor que resuelve la promesa con validate = true: Un arreglo con objetos que representan links. Cada objeto tiene las propiedades: href: URL encontrada. text: Texto que aparecía dentro del link. file: Ruta del archivo donde se encontró el link. status: Código de respuesta HTTP. ok: Mensaje fail en caso de fallo u ok en caso de éxito. Ejemplo: (resultados como comentarios) const mdLinks = require("md-links"); mdLinks("./some/example.md") .then(links => { // => [{ href, text, file }, ...] }) .catch(console.error); mdLinks("./some/example.md", true) .then(links => { // => [{ href, text, file, status, ok }, ...] }) .catch(console.error); mdLinks("./some/example.md", false) .then(links => { // => [{ href, text, file }, ...] }) .catch(console.error); ⚠️ Test unitarios. Antes de pasar al siguiente hito, asegúrate de hacer los tests del hito actual. Los tests aquí van a mockear http, fecth o axios.
No due date•1/1 issues closedHITO 1: Javascript API Comienza haciendo la versión más sencilla de mdlinks. Crea una función que retorne una promesa con los links encontrados dentro de un archivo Markdown específico. Esta función debe ser un módulo que puede importarse en otros scripts de Node.js y debe ofrecer la siguiente interfaz: mdLinks(path) Argumento: path: Ruta absoluta o relativa al archivo. Si la ruta pasada es relativa, debe resolverse como relativa al directorio desde donde se invoca node (transformar a absoluta). Valor de retorno: La función mdLinks(path) debe retornar una promesa que resuelva a un arreglo de objetos, donde cada objeto representa un link y contiene las siguientes propiedades: href: URL encontrada. text: Texto que aparecía dentro del link. file: Ruta del archivo donde se encontró el link. Ejemplo: (resultados como comentarios) const mdLinks = require("md-links"); mdLinks("./some/example.md") .then(links => { // => [{ href, text, file }, ...] }) .catch(console.error); Test unitarios: Los tests unitarios son una excelente forma de verificar si tus funciones están funcionando correctamente mientras escribes el código. En este proyecto, recuerda que no hay una interfaz gráfica de navegador, por lo tanto para poderlo probar es necesario recurrir a los test unitarios. Recuerda que es muy importante testear tus funciones puras, mientras escribes la función mdLinks. También deberás testearla al final asegurándote que resuelva un arreglo con la información esperada. Ejemplo: describe('mdLinks', () => { it('debería resolver un arreglo con 3 links para un archivo .md con 3 links', () => { return mdLinks('miArchivo.md').then((result) => { expect...; }); }); }); Tareas de este hito Crea una Promesa El valor de retorno de nuestra librería es una Promesa que resuelve un array. Prueba leyendo sobre las promesas y creando una por tu cuenta utilizando new Promise() Es importante que sepas qué es un callback pues las promesas los utilizarán. Transforma la ruta ingresada a absoluta Los módulos de Node.js que utilizarás después, trabajan con rutas absolutas. Entonces, si a la función mdlinks(), se le pasa una ruta relativa, debes convertirla a absoluta primero. Puedes valerte del módulo path, con su método resolve(). Comprueba que la ruta existe en el computador Una vez que tienes la ruta absoluta, asegúrate que la ruta exista en el computador. Este paso es importante, ya que si la ruta ingresada es erronea la función mdLinks() deberá rechazarse con un error. Asegúrate que el archivo es Markdown Como la ruta que se utilizará para este hito, será la ruta de un archivo en específico, aventúrate a conocer cuál es su extensión. Recuerda, las extensiones son esas letras al final del nombre de un archivo, por ejemplo: .js, .txt, .doc, etc. Aquí podrá ser útil el módulo path. Ten en cuenta que un archivo es considerado Markdown si tiene cualquiera de las siguientes extensiones: .md, .mkd, .mdwn, .mdown, .mdtxt, .mdtext, .markdown, .text; así que en caso de que la extensión del archivo no sea alguna de las anteriores, la promesa de la función mdLinks debería rechazarse con un error. Lee un archivo Ahora que sabes que el archivo es del tipo Markdown, lee este archivo y retorna su contenido. Para ver este contenido puedes utilizar un console.log() al momento de ejecutar la función. El módulo fs (FileSystem) te será de utilidad. Como mencionamos en las consideraciones técnicas, preferimos que uses readFile (en lugar de readFileSync) y recomendamos el módulo fs/promises para utilizar estas funciones con promesas. Encuentra los links dentro del documento Una vez tienes acceso al contenido del archivo, extrae los links que encuentres dentro del mismo. Estos links los tendrás que armar dentro de un arreglo para que la función de mdLinks los pueda resolver. ⚠️ Antes de pasar al siguiente hito, asegúrate de escribir los tests correspondientes al código del hito actual.
No due date•5/5 issues closed