diff --git a/README.md b/README.md index d4df79b..bfb2a5a 100644 --- a/README.md +++ b/README.md @@ -1,666 +1,520 @@ # Markdown Links +*** +## Features +*** +Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchísimas plataformas que manejan texto plano (GitHub, foros, blogs, ...), y es muy común encontrar varios archivos en ese formato en cualquier tipo de repositorio (empezando por el tradicional README.md). + +Estos archivos Markdown normalmente contienen links (vínculos/ligas) que muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de la información que se quiere compartir. -## Índice +Dentro de una comunidad de código abierto, nos han propuesto crear una herramienta usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas. -* [1. Preámbulo](#1-preámbulo) -* [2. Resumen del proyecto](#2-resumen-del-proyecto) -* [3. Objetivos de aprendizaje](#3-objetivos-de-aprendizaje) -* [4. Consideraciones generales](#4-consideraciones-generales) -* [5. Criterios de aceptación mínimos del proyecto](#5-criterios-de-aceptación-mínimos-del-proyecto) -* [6. Entregables](#6-entregables) -* [7. Hacker edition](#7-hacker-edition) -* [8. Pistas, tips y lecturas complementarias](#8-pistas-tips-y-lecturas-complementarias) -* [9. Checklist](#9-checklist) -* [10. Achicando el problema](#10-achicando-el-problema) +![md-links](https://user-images.githubusercontent.com/110297/42118443-b7a5f1f0-7bc8-11e8-96ad-9cc5593715a6.jpg) + +## Introduction *** +Node.js es un entorno de ejecución para JavaScript construido con el motor de JavaScript V8 de Chrome. Esto nos va a permitir ejecutar JavaScript en el entorno del sistema operativo, ya sea tu máquina o un servidor, lo cual nos abre las puertas para poder interactuar con el sistema en sí, archivos, redes, ... + +En este proyecto nos alejamos un poco del navegador para construir un programa que se ejecute usando Node.js, donde aprenderemos sobre cómo interactuar con el sistema archivos, con el entorno (proceso, env, stdin/stdout/stderr), ... + +## Objectives +*** +El objetivo de esta librería es crear una herramienta que facilite a las personas a encontrar los links que hay dentro de un texto plano y verificar el status de estos, es decir, la librería verifica si los links estan rotos o son links funcionales y hace diferentes reportes con la información resumida. + +## Flowchart + +![flowchart](./imgdrawio/drawio1.png) +![flowchart](./imgdrawio/drawio2.png) +![flowchart](./imgdrawio/drawio3.png) + +## Usability mode +*** +La manera en que debe usarse es tecleando en la terminal primero el nombre del archivo o carpeta a analizar y despues alguno de los siguientes comandos: + +mdlinks - Para obtener un reporte de los links que hay en el archivo o carpeta, asi como la ruta de cada uno de ellos +--validate - para obtener un reporte de los links, su status, es decir, si esta roto o no y la ruta absoluta del archivo donde se encuentra el link +-- stats - con este comado se encontrará una estadística de los links totales y los links únicos. +-stats -validate - con este comando la librería arroja una estadística de los totales, los únicos y los links que están rotos. +Esta librería utiliza la recursividad, por lo que si la ruta que se le agregó es carpeta, analiza todos los archivos con extetnsióm .md que haya dentro de la misma y si es carpeta, busca dentro de la misma, hasta desglosarse en puros archivos .md + +### Este proyecto consta de DOS partes +*** +1) JavaScript API +El módulo debe poder importarse en otros scripts de Node.js y debe ofrecer la siguiente interfaz: + +mdLinks(path, options) +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 - current working directory). + +options: Un objeto con únicamente la siguiente propiedad: +validate: Booleano que determina si se desea validar los links encontrados. +Valor de retorno +La función debe retornar una promesa (Promise) que resuelva a un arreglo (Array) de objetos (Object), donde cada objeto representa un link y contiene las siguientes propiedades + +Con validate: false : + +href: URL encontrada. +text: Texto que aparecía dentro del link (). +file: Ruta del archivo donde se encontró el link. +Con validate:true : + +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"); + + +2) CLI (Command Line Interface - Interfaz de Línea de Comando) +El ejecutable de nuestra aplicación debe poder ejecutarse de la siguiente manera a través de la terminal: + +md-links [options] + +Por ejemplo: + + md-links ./some/example.md +./some/example.md http://algo.com/2/3/ Link a algo +./some/example.md https://otra-cosa.net/algun-doc.html algún doc +./some/example.md http://google.com/ Google +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: + + md-links ./some/example.md --validate +./some/example.md http://algo.com/2/3/ ok 200 Link a algo +./some/example.md https://otra-cosa.net/algun-doc.html fail 404 algún doc +./some/example.md http://google.com/ ok 301 Google +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. + + md-links ./some/example.md --stats +Total: 3 +Unique: 3 +También podemos combinar --stats y --validate para obtener estadísticas que necesiten de los resultados de la validación. + +md --stats --validate + + + + + +En tu consola ejecuta el siguiente comando: + +### npm i mdlinks-taniafe + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -## 1. Preámbulo -[Markdown](https://es.wikipedia.org/wiki/Markdown) es un lenguaje de marcado -ligero muy popular entre developers. Es usado en muchísimas plataformas que -manejan texto plano (GitHub, foros, blogs, ...) y es muy común -encontrar varios archivos en ese formato en cualquier tipo de repositorio -(empezando por el tradicional `README.md`). -Estos archivos `Markdown` normalmente contienen _links_ (vínculos/ligas) que -muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de -la información que se quiere compartir. -Dentro de una comunidad de código abierto, nos han propuesto crear una -herramienta usando [Node.js](https://nodejs.org/), que lea y analice archivos -en formato `Markdown`, para verificar los links que contengan y reportar -algunas estadísticas. -![md-links](https://user-images.githubusercontent.com/110297/42118443-b7a5f1f0-7bc8-11e8-96ad-9cc5593715a6.jpg) -## 2. Resumen del proyecto -En este proyecto crearás una herramienta de línea de comando (CLI) así como tu -propia librería (o biblioteca - library) en JavaScript. -En esta oportunidad nos alejamos un poco del navegador para construir un -programa que se ejecute usando Node.js. Aprenderemos sobre procesos -(`process.env`, `process.argv`, ...), cómo interactuar con el sistema archivos, -cómo hacer consultas de red, etc. -[Node.js](https://nodejs.org/es/) es un entorno de ejecución para JavaScript -construido con el [motor de JavaScript V8 de Chrome](https://developers.google.com/v8/). -Esto nos va a permitir ejecutar JavaScript en el entorno del sistema operativo, -ya sea tu máquina o un servidor, lo cual nos abre las puertas para poder -interactuar con el sistema en sí, archivos, redes, ... -Diseñar tu propia librería es una experiencia fundamental para cualquier -desarrollador porque que te obliga a pensar en la interfaz (API) de tus -_módulos_ y cómo será usado por otros developers. Debes tener especial -consideración en peculiaridades del lenguaje, convenciones y buenas prácticas. -## 3. Objetivos de aprendizaje -Reflexiona y luego marca los objetivos que has llegado a entender y aplicar en tu proyecto. Piensa en eso al decidir tu estrategia de trabajo. -### JavaScript -- [ ] **Diferenciar entre tipos de datos primitivos y no primitivos** -- [ ] **Arrays (arreglos)** -
Links

- * [Arreglos](https://curriculum.laboratoria.la/es/topics/javascript/04-arrays) - * [Array - MDN](https://developer.mozilla.org/es/docs/Web/JavaScript/Reference/Global_Objects/Array/) - * [Array.prototype.sort() - MDN](https://developer.mozilla.org/es/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) - * [Array.prototype.forEach() - MDN](https://developer.mozilla.org/es/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach) - * [Array.prototype.map() - MDN](https://developer.mozilla.org/es/docs/Web/JavaScript/Reference/Global_Objects/Array/map) - * [Array.prototype.filter() - MDN](https://developer.mozilla.org/es/docs/Web/JavaScript/Reference/Global_Objects/Array/filter) - * [Array.prototype.reduce() - MDN](https://developer.mozilla.org/es/docs/Web/JavaScript/Reference/Global_Objects/Array/Reduce) -

-- [ ] **Objetos (key, value)** -
Links

- * [Objetos en JavaScript](https://curriculum.laboratoria.la/es/topics/javascript/05-objects/01-objects) -

-- [ ] **Uso de condicionales (if-else, switch, operador ternario, lógica booleana)** -
Links

- * [Estructuras condicionales y repetitivas](https://curriculum.laboratoria.la/es/topics/javascript/02-flow-control/01-conditionals-and-loops) - * [Tomando decisiones en tu código — condicionales - MDN](https://developer.mozilla.org/es/docs/Learn/JavaScript/Building_blocks/conditionals) -

-- [ ] **Funciones (params, args, return)** -
Links

- * [Funciones (control de flujo)](https://curriculum.laboratoria.la/es/topics/javascript/02-flow-control/03-functions) - * [Funciones clásicas](https://curriculum.laboratoria.la/es/topics/javascript/03-functions/01-classic) - * [Arrow Functions](https://curriculum.laboratoria.la/es/topics/javascript/03-functions/02-arrow) - * [Funciones — bloques de código reutilizables - MDN](https://developer.mozilla.org/es/docs/Learn/JavaScript/Building_blocks/Functions) -

-- [ ] **Recursión o recursividad** -
Links

- * [Píldora recursión - YouTube Laboratoria Developers](https://www.youtube.com/watch?v=lPPgY3HLlhQ) - * [Recursión o Recursividad - Laboratoria Developers en Medium](https://medium.com/laboratoria-developers/recursi%C3%B3n-o-recursividad-ec8f1a359727) -

-- [ ] **Módulos de CommonJS** -
Links

- * [Modules: CommonJS modules - Node.js Docs](https://nodejs.org/docs/latest/api/modules.html) -

-- [ ] **Diferenciar entre expresiones (expressions) y sentencias (statements)** -- [ ] **Callbacks** -
Links

- * [Función Callback - MDN](https://developer.mozilla.org/es/docs/Glossary/Callback_function) -

-- [ ] **Promesas** -
Links

- * [Promise - MDN](https://developer.mozilla.org/es/docs/Web/JavaScript/Reference/Global_Objects/Promise) - * [How to Write a JavaScript Promise - freecodecamp (en inglés)](https://www.freecodecamp.org/news/how-to-write-a-javascript-promise-4ed8d44292b8/) -

-- [ ] **Pruebas unitarias (unit tests)** -
Links

- * [Empezando con Jest - Documentación oficial](https://jestjs.io/docs/es-ES/getting-started) -

-- [ ] **Pruebas asíncronas** -
Links

- * [Tests de código asincrónico con Jest - Documentación oficial](https://jestjs.io/docs/es-ES/asynchronous) -

-- [ ] **Uso de mocks y espías** -
Links

- * [Manual Mocks con Jest - Documentación oficial](https://jestjs.io/docs/es-ES/manual-mocks) -

-- [ ] **Pruebas de compatibilidad en múltiples entornos de ejecución** -- [ ] **Uso de linter (ESLINT)** -- [ ] **Uso de identificadores descriptivos (Nomenclatura y Semántica)** -### Node.js -- [ ] **Instalar y usar módulos con npm** -
Links

- * [Sitio oficial de npm (en inglés)](https://www.npmjs.com/) -

-- [ ] **Configuración de package.json** -
Links

- * [package.json - Documentación oficial (en inglés)](https://docs.npmjs.com/files/package.json) -

-- [ ] **Configuración de npm-scripts** -
Links

- * [scripts - Documentación oficial (en inglés)](https://docs.npmjs.com/misc/scripts) -

-- [ ] **process (env, argv, stdin-stdout-stderr, exit-code)** -
Links

- * [Process - Documentación oficial (en inglés)](https://nodejs.org/api/process.html) -

-- [ ] **File system (fs, path)** -
Links

- * [File system - Documentación oficial (en inglés)](https://nodejs.org/api/fs.html) - * [Path - Documentación oficial (en inglés)](https://nodejs.org/api/path.html) -

-### Control de Versiones (Git y GitHub) -- [ ] **Git: Instalación y configuración** -- [ ] **Git: Control de versiones con git (init, clone, add, commit, status, push, pull, remote)** -- [ ] **Git: Integración de cambios entre ramas (branch, checkout, fetch, merge, reset, rebase, tag)** -- [ ] **GitHub: Creación de cuenta y repos, configuración de llaves SSH** -- [ ] **GitHub: Colaboración en Github (branches | forks | pull requests | code review | tags)** -- [ ] **GitHub: Organización en Github (projects | issues | labels | milestones | releases)** -### HTTP -- [ ] **Consulta o petición (request) y respuesta (response).** -
Links

- * [Generalidades del protocolo HTTP - MDN](https://developer.mozilla.org/es/docs/Web/HTTP/Overview) - * [Mensajes HTTP - MDN](https://developer.mozilla.org/es/docs/Web/HTTP/Messages) -

-- [ ] **Códigos de status de HTTP** -
Links

- * [Códigos de estado de respuesta HTTP - MDN](https://developer.mozilla.org/es/docs/Web/HTTP/Status) - * [The Complete Guide to Status Codes for Meaningful ReST APIs - dev.to](https://dev.to/khaosdoctor/the-complete-guide-to-status-codes-for-meaningful-rest-apis-1-5c5) -

-## 4. Consideraciones generales -* Este proyecto se debe "resolver" de manera individual. -* La **librería** y el **script ejecutable** (herramienta de línea de comando - - CLI) deben estar implementados en JavaScript para ser ejecutados con - Node.js. **Está permitido usar librerías externas**. -* Tu módulo **debe ser instalable** via `npm install /md-links`. Este - módulo 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 **tests unitarios** deben cubrir un mínimo del 70% de _statements_, - _functions_, _lines_ y _branches_. Te recomendamos explorar [Jest](https://jestjs.io/) - para tus pruebas unitarias. -* Para este proyecto **no está permitido** utilizar `async/await`. -* Para este proyecto te sugerimos **no utilizar** la versión síncrona -de la función para leer archivos, `readFileSync`, y en cambio intentar -resolver este desafío de manera asíncrona. -* Para este proyecto es **opcional** el uso de ES Modules `(import/export)`, en el - caso optes utilizarlo deberás de crear un script de `build` en el `package.json` - que los transforme en `requires` y `module.exports` con ayuda de **babel**. -* Para disminuir la complejidad de tu algoritmo recursivo, te recomendamos -utilizar la versión síncrona de la función para leer directorios, `readdirSync`. -## 5. Criterios de aceptación mínimos del proyecto -Para comenzar este proyecto tendrás que hacer un **_fork_** y **_clonar_** este -repositorio. -Antes de comenzar a codear, es necesario crear un **plan de acción**. Esto debería -quedar detallado en el `README.md` de tu repo y en una serie de **_issues_** -y **_milestones_** para priorizar y organizar el trabajo, y para poder hacer -seguimiento de tu progreso. -Dentro de cada **_milestone_** se crearán y asignarán los **_issues_** que cada quien -considere necesarios. -### Archivos del proyecto -* `README.md` con descripción del módulo, instrucciones de instalación/uso, - documentación del API y ejemplos. Todo lo relevante para que cualquier - developer que quiera usar tu librería pueda hacerlo sin inconvenientes. -* `index.js`: Desde este archivo debes exportar **una** función (`mdLinks`). -* `package.json` con nombre, versión, descripción, autores, licencia, - dependencias, scripts (pretest, test, ...), main, bin -* `.editorconfig` con configuración para editores de texto. Este archivo no se - debe cambiar. -* `.eslintrc` con configuración para linter. Este archivo contiene una - configuración básica para ESLint, si deseas agregar reglas adicionales - como Airbnb deberás modificar este archivo. -* `.gitignore` para ignorar `node_modules` u otras carpetas que no deban - incluirse en control de versiones (`git`). -* `test/md-links.spec.js` debe contener los tests unitarios para la función - `mdLinks()`. Tu inplementación debe pasar estos tets. -## Este proyecto consta de DOS partes -### 1) JavaScript API -El módulo debe poder **importarse** en otros scripts de Node.js y debe ofrecer la -siguiente interfaz: -#### `mdLinks(path, options)` -##### 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 - _current working directory_). -* `options`: Un objeto con **únicamente** la siguiente propiedad: - - `validate`: Booleano que determina si se desea validar los links - encontrados. -##### Valor de retorno -La función debe **retornar una promesa** (`Promise`) que **resuelva a un arreglo** -(`Array`) de objetos (`Object`), donde cada objeto representa un link y contiene -las siguientes propiedades -Con `validate:false` : -* `href`: URL encontrada. -* `text`: Texto que aparecía dentro del link (``). -* `file`: Ruta del archivo donde se encontró el link. -Con `validate:true` : -* `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) -```js -const mdLinks = require("md-links"); -mdLinks("./some/example.md") - .then(links => { - // => [{ href, text, file }, ...] - }) - .catch(console.error); -mdLinks("./some/example.md", { validate: true }) - .then(links => { - // => [{ href, text, file, status, ok }, ...] - }) - .catch(console.error); -mdLinks("./some/dir") - .then(links => { - // => [{ href, text, file }, ...] - }) - .catch(console.error); -``` -### 2) CLI (Command Line Interface - Interfaz de Línea de Comando) -El ejecutable de nuestra aplicación debe poder ejecutarse de la siguiente -manera a través de la **terminal**: -`md-links [options]` -Por ejemplo: -```sh -$ md-links ./some/example.md -./some/example.md http://algo.com/2/3/ Link a algo -./some/example.md https://otra-cosa.net/algun-doc.html algún doc -./some/example.md http://google.com/ Google -``` -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: -```sh -$ md-links ./some/example.md --validate -./some/example.md http://algo.com/2/3/ ok 200 Link a algo -./some/example.md https://otra-cosa.net/algun-doc.html fail 404 algún doc -./some/example.md http://google.com/ ok 301 Google -``` -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. -```sh -$ md-links ./some/example.md --stats -Total: 3 -Unique: 3 -``` -También podemos combinar `--stats` y `--validate` para obtener estadísticas que -necesiten de los resultados de la validación. -```sh -$ md-links ./some/example.md --stats --validate -Total: 3 -Unique: 3 -Broken: 1 -``` -## 6. Entregables -Módulo instalable via `npm install /md-links`. Este módulo debe -incluir tanto **un ejecutable** como **una interfaz** que podamos importar con `require` -para usarlo programáticamente. -## 7. Hacker edition -Las secciones llamadas _Hacker Edition_ son **opcionales**. Si **terminaste** -con todo lo anterior y te queda tiempo, intenta completarlas. Así podrás -profundizar y/o ejercitar más sobre los objetivos de aprendizaje del proyecto. -* Puedes agregar la propiedad `line` a cada objeto `link` indicando en qué línea - del archivo se encontró el link. -* Puedes agregar más estadísticas. -* Integración continua con Travis o Circle CI. -*** -## 8. Pistas, tips y lecturas complementarias -### FAQs -#### ¿Cómo hago para que mi módulo sea _instalable_ desde GitHub? -Para que el módulo sea instalable desde GitHub solo tiene que: -* Estar en un repo público de GitHub -* Contener un `package.json` válido -Con el comando `npm install githubname/reponame` podemos instalar directamente -desde GitHub. Ver [docs oficiales de `npm install` acá](https://docs.npmjs.com/cli/install). -Por ejemplo, el [`course-parser`](https://github.com/Laboratoria/course-parser) -que usamos para la currícula no está publicado en el registro público de NPM, -así que lo instalamos directamente desde GitHub con el comando `npm install -Laboratoria/course-parser`. -### Sugerencias de implementación -La implementación de este proyecto tiene varias partes: leer del sistema de -archivos, recibir argumentos a través de la línea de comando, analizar texto, -hacer consultas HTTP, ... y todas estas cosas pueden enfocarse de muchas formas, -tanto usando librerías como implementando en VanillaJS. -Por poner un ejemplo, el _parseado_ (análisis) del markdown para extraer los -links podría plantearse de las siguientes maneras (todas válidas): -* Usando un _módulo_ como [markdown-it](https://github.com/markdown-it/markdown-it), - que nos devuelve un arreglo de _tokens_ que podemos recorrer para identificar - los links. -* Siguiendo otro camino completamente, podríamos usar - [expresiones regulares (`RegExp`)](https://developer.mozilla.org/es/docs/Web/JavaScript/Guide/Regular_Expressions). -* También podríamos usar una combinación de varios _módulos_ (podría ser válido - transformar el markdown a HTML usando algo como [marked](https://github.com/markedjs/marked) - y de ahí extraer los link con una librería de DOM como [JSDOM](https://github.com/jsdom/jsdom) - o [Cheerio](https://github.com/cheeriojs/cheerio) entre otras). -* Usando un _custom renderer_ de [marked](https://github.com/markedjs/marked) - (`new marked.Renderer()`). -No dudes en consultar a tus compañeras y coaches -si tienes dudas existenciales con respecto a estas decisiones. No existe una -"única" manera correcta :wink: -### Tutoriales / NodeSchool workshoppers -* [learnyounode](https://github.com/workshopper/learnyounode) -* [how-to-npm](https://github.com/workshopper/how-to-npm) -* [promise-it-wont-hurt](https://github.com/stevekane/promise-it-wont-hurt) -### Otros recursos -* [Acerca de Node.js - Documentación oficial](https://nodejs.org/es/about/) -* [Node.js file system - Documentación oficial](https://nodejs.org/api/fs.html) -* [Node.js http.get - Documentación oficial](https://nodejs.org/api/http.html#http_http_get_options_callback) -* [Node.js - Wikipedia](https://es.wikipedia.org/wiki/Node.js) -* [What exactly is Node.js? - freeCodeCamp](https://medium.freecodecamp.org/what-exactly-is-node-js-ae36e97449f5) -* [¿Qué es Node.js y para qué sirve? - drauta.com](https://www.drauta.com/que-es-nodejs-y-para-que-sirve) -* [¿Qué es Nodejs? Javascript en el Servidor - Fazt en YouTube](https://www.youtube.com/watch?v=WgSc1nv_4Gw) -* [¿Simplemente qué es Node.js? - IBM Developer Works, 2011](https://www.ibm.com/developerworks/ssa/opensource/library/os-nodejs/index.html) -* [Node.js y npm](https://www.genbeta.com/desarrollo/node-js-y-npm) -* [Módulos, librerías, paquetes, frameworks... ¿cuál es la diferencia?](http://community.laboratoria.la/t/modulos-librerias-paquetes-frameworks-cual-es-la-diferencia/175) -* [Asíncronía en js](https://carlosazaustre.es/manejando-la-asincronia-en-javascript) -* [NPM](https://docs.npmjs.com/getting-started/what-is-npm) -* [Publicar packpage](https://docs.npmjs.com/getting-started/publishing-npm-packages) -* [Crear módulos en Node.js](https://docs.npmjs.com/getting-started/publishing-npm-packages) -* [Leer un archivo](https://nodejs.org/api/fs.html#fs_fs_readfile_path_options_callback) -* [Leer un directorio](https://nodejs.org/api/fs.html#fs_fs_readdir_path_options_callback) -* [Path](https://nodejs.org/api/path.html) -* [Linea de comando CLI](https://medium.com/netscape/a-guide-to-create-a-nodejs-command-line-package-c2166ad0452e) -## 9. Checklist -### General -* [ ] Puede instalarse via `npm install --global /md-links` -### `README.md` -* [ ] Un board con el backlog para la implementación de la librería. -* [ ] Documentación técnica de la librería. -* [ ] Guía de uso e instalación de la librería -### API `mdLinks(path, opts)` -* [ ] El módulo exporta una función con la interfaz (API) esperada. -* [ ] Implementa soporte para archivo individual -* [ ] Implementa soporte para directorios -* [ ] Implementa `options.validate` -### CLI -* [ ] Expone ejecutable `md-links` en el path (configurado en `package.json`) -* [ ] Se ejecuta sin errores / output esperado -* [ ] Implementa `--validate` -* [ ] Implementa `--stats` -### Pruebas / tests -* [ ] Pruebas unitarias cubren un mínimo del 70% de statements, functions, - lines, y branches. -* [ ] Pasa tests (y linters) (`npm test`). -## 10. Achicando el problema -Un "superpoder" que esperamos puedas desarrollar durante el bootcamp -es el de definir "mini-proyectos" que te acerquen paso a paso a -la solución del "gran proyecto". Es el equivalente a comenzar armando -esquinas o bordes del rompecabezas/puzzle sin saber necesariamente -cómo encajarán al final. Déjate llevar y explora. -Estas son algunas sugerencias: -### Empieza con un diagrama de flujo -Este proyecto es distinto de los que has venido trabajando hasta ahora -dado que no hay una interfaz web, todo se desarrollará en tu editor y -consola/terminal. -Es por ello que, para visualizar mejor lo que tendrás que hacer -y planificar tus tareas y objetivos, es recomendable hacer un -`diagrama de flujo`. -Si nunca has hecho un diagrama de flujo revisa este [recurso](https://www.youtube.com/watch?v=Lub5qOmY4JQ). -Una alternativa al diagrama de flujo puede ser el `pseudocódigo`. -### Planificación -En este proyecto te recomendamos usar la herramienta de planificación -y organización de GitHub llamada **Github Projects**. -Mediante **issues** y **milestones** podrás organizar y planificar -tareas y objetivos concretos. -Tomando en consideración los **entregables** del proyecto, el -[9. Checklist](#9-checklist) y los **pasos** que definiste en tu -`diagrama de flujo`, crea tu planificación en GitHub Projects. -### Antes de codear -En esta ocasión estarás trabajando en **NodeJS**, asegúrate -de saber para qué sirve y sus consideraciones. -En particular, deberás decidir desde un comienzo si usarás -`ES Modules`, es decir, **import/export**, ó, por el contrario, -`CommonJS Modules`, es decir, **require/module.exports**. -Asegurate de tener clara esta decisión desde un inicio para -que no encuentres problemas más adelante. -### Lee un archivo -Como primer reto, puedes tratar de leer un solo archivo con -una ruta fija e imprimir su contenido en la consola con un `console.log`. -La librería nativa `FS` (FileSystem) te será de utilidad. -**Recuerda**: Te sugerimos **no utilizar** la versión síncrona -de la función para leer archivos, `readFileSync`, y en cambio -intentar resolver ese desafío de manera asíncrona. -### Averigua la extensión de un archivo -Ya sabiendo leer un archivo, aventúrate a conocer cual -es su extensión. -Recuerda, las extensiones son esas letras al final del -nombre de un archivo, por ejemplo: .js, .txt, .doc, etc -Aquí también podrá ser útil `FS`. -### Obtén el contenido de un directorio -Este proyecto consiste en buscar archivos, pero para eso, -primero debes poder verlos. -Intenta imprimir en consola la lista de archivos en una carpeta. -La librería `FS` también te será útil aquí. -**Recuerda**: Para disminuir la complejidad de tu algoritmo -recursivo, te recomendamos utilizar la versión síncrona de -la función para leer directorios, `readdirSync`. -### Une dos rutas -Para poder acceder a carpetas y archivos será necesario que -indiques en qué lugar de tu computadora se encuentran, a esto -le llamamos **rutas**. -Usa la librería nativa `path` para unir dos segmentos de ruta, -por ejemplo, si queremos unir: -1) /home/Laboratoria/ -2) ./test -El resultado sería: /home/Laboratoria/test -### Recursividad -Este proyecto se ha de resolver de forma casi natural con -**recursividad**. -¿Por qué?. -Porque no conocemos realmente cuantas carpetas y archivos -tendremos que recorrer antes de terminar. -Si recibes una ruta de carpeta, no sabrás de ante mano si -dentro hay más carpetas o muchos archivos. -Por ello, asegurate bien de entender de qué trata la -recursividad y ver algunos ejemplos. -Entre los recursos de este proyecto hay un video que te ayudará. -### Crea una promesa -El valor de retorno de nuestra librería es una `Promesa`, -no 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. diff --git a/cli.js b/cli.js new file mode 100644 index 0000000..e70a551 --- /dev/null +++ b/cli.js @@ -0,0 +1,21 @@ +#!/usr/bin/env node + +const mdLinks = require('./mdLinks'); // se importa la función mdLinks +const process = require("process"); +const colors = require("colors"); + +const path2 = process.argv[2]; +const pathOptions1 = process.argv[3]; +const pathOptions2 = process.argv[4]; +const arOptions = [pathOptions1, pathOptions2]; //Se crea un arreglo que contiene las opciones que se van a aplicar al análisis + +mdLinks(path2, arOptions); + +module.exports = mdLinks; + +// console.log(colors.bgYellow('Probando...')); +// console.log(colors.rainbow('MdLinks')); +// console.log(colors.magenta('trabajando con Node.js')); +// console.log(colors.bgCyan('<3')); + + diff --git a/examplesFiles/prueba2.md b/examplesFiles/prueba2.md new file mode 100644 index 0000000..3770729 --- /dev/null +++ b/examplesFiles/prueba2.md @@ -0,0 +1,3 @@ +motor de JavaScript V8 de Chrome. Esto nos va a permitir ejecutar JavaScript en el entorno del sistema operativo, ya sea tu máquina o un servidor, lo cual nos abre las puertas para poder interactuar con el sistema en sí, archivos, redes, ... + +Dentro de una comunidad de código abierto, nos han propuesto crear una herramienta usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas. https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing12345/Client-side_JavaScript_frameworks diff --git a/examplesFiles/pruebas/ejemplos/prueba1.md b/examplesFiles/pruebas/ejemplos/prueba1.md new file mode 100644 index 0000000..7b43153 --- /dev/null +++ b/examplesFiles/pruebas/ejemplos/prueba1.md @@ -0,0 +1,8 @@ +1. Preámbulo +Markdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchísimas plataformas que manejan texto plano (GitHub, foros, blogs, ...), y es muy común encontrar varios archivos en ese formato en cualquier tipo de repositorio (empezando por el tradicional README.md). + +Estos archivos Markdown normalmente contienen links (vínculos/ligas) que muchas veces están rotos o ya no son válidos y eso perjudica mucho el valor de la información que se quiere compartir. + +Dentro de una comunidad de código abierto, nos han propuesto crear una herramienta usando Node.js, que lea y analice archivos en formato Markdown, para verificar los links que contengan y reportar algunas estadísticas. + +Módulos, librerías, paquetes, frameworks... ¿cuál es la diferencia? \ No newline at end of file diff --git a/examplesFiles/pruebas/prueba0.md b/examplesFiles/pruebas/prueba0.md new file mode 100644 index 0000000..db58955 --- /dev/null +++ b/examplesFiles/pruebas/prueba0.md @@ -0,0 +1,7 @@ +[Markdown](https://es.wikipedia.org/wiki/Markdown) +[motor de JavaScript V8 de Chrome](https://developers.google.com/v8/) +[Arreglos](https://curriculum.laboratoria.la/es/topics/javascript/04-arrays) +[Objetos en JavaScript](https://curriculum.laboratoria.la/es/topics/javascript/05-objects/01-objects) +[JSDOM](https://github.com/jsdom/jsdom/gy) +[NPM](https://docs.npmjs.com/getting-started/what-is-npm) +[Leer un directorio](https://nodejs.org/api/fs.html#fs_fs_readdir_path_options_callback) \ No newline at end of file diff --git a/functions.js b/functions.js new file mode 100644 index 0000000..11ef2cc --- /dev/null +++ b/functions.js @@ -0,0 +1,213 @@ +const fs = require("fs"); +const path = require("path"); +const process = require("process"); +const axios = require("axios"); +const colors = require("colors"); +// console.log(fs); + +//FUNCIONES A UTILIZAR + +//¿La ruta existe? +// console.log(fs.existsSync('./pruebas')); +const validPath = (route) => fs.existsSync(route); + +//¿La ruta es absoluta? +// console.log(path.isAbsolute('./pruebas')); +const absolutePath = (route) => path.isAbsolute(route); + +//convierte la ruta de relativa en absoluta +// console.log(process.cwd("./pruebas")); +// ruta transformada: C:\Users\tania\OneDrive\Escritorio\Proyectos Laboratoria\mdLinks\DEV002-md-links + +const transformAbs = (route) => { + const validDir = process.cwd(); //verifica si el arcivo existe en el local + return path.resolve(validDir, route); //si es directorio, devuelve una ruta absoluta +}; + +//¿Es un directorio? + +const validDir = (route) => { + //devuelve 'true' si la ruta especificada es una carpeta válida, y 'false' si no lo es. + const stats = fs.statSync(route); + return stats.isDirectory(); +}; + +//lee los archivos del directorio +//console.log(fs.readdirSync('./pruebas')); debería devolver un array con el contenido de ese directorio +const readFile = (route) => fs.readdirSync(route); + +//validar que la función sea md devuelve la ext se un arch +const mdFile = (route) => (path.extname(route) === ".md" ? true : false); + +//recursividad +const recursive = (route) => { + let arrReadMd = []; + if (mdFile(route)) { + arrReadMd.push(route); //se llena si la ruta tiene ext md si no es un directorio + } else if (validDir(route)) { + const contentRoute = readFile(route); //leer las rutas del directorio e itera el contenido que tiene + contentRoute.forEach((pathRoute) => { + //route es el elemt que se esta iterando del arr de string que me devolv contenRoute + + arrReadMd = arrReadMd.concat(recursive(`${route}/${pathRoute}`)); + }) + } + return arrReadMd; +}; + +//lee directorios y retorna archivos md + +const readFileMd = (route) => { + return new Promise((res, rej) => { + fs.readFile(route, "utf-8", (error, data) => { + error ? rej("Ocurrió un error") : res(data); + + }); + }); +}; +// const readFileMd = (route) => { +// return new Promise((res, rej) => { +// fs.readFile(route, "utf-8", (error, data) => { +// error ? rej("ocurrió un error") : res(data); +// }); +// }); +// }; + +//Validar todo tipo de ruta 'false' +const routeFalse = (route) => { + return new Promise((res, rej) => { + const allLinks = []; //usar este array para crear un objeto + readFileMd(route) //promesa(lento) probar con readme readContentMd + .then((data) => { + const regExp = + /\[([\w\s\d]+)\]\(((?:\/|https?:\/\/)[\w\d./?=#]+[a-zA-Z0-9!-_$]+)\)/gi; + + //regExp.exec(data)//devuelve array con link que cumplan con la regEx... + + let resultRegEx = regExp.exec(data); //devuelve array iterado + while (resultRegEx !== null) { + // evitar que me devuelva null + + allLinks.push({ + href: resultRegEx[2], + text: resultRegEx[1], + file: route, //probar con readme + }); + resultRegEx = regExp.exec(data); + } + res(allLinks); + }) + .catch((error) => { + rej(error); + }); + }); +}; + +// routeFalse('README.md') +// .then((data) => { +// console.log(data) +// }) +// .catch((error) => { +// console.log(error); +// }); + +//validar ruta (true) devolver un array de objeto + +const trueRoute = (allLinks) => { + // simulando parameter + return Promise.all( + allLinks.map((content) => { + //cada objeto es una promesa y all me dev un array de promesa + return axios //peticiones http a un serv + .get(content.href) //hace peticion para obtener datos obtener inf de esa url + .then((data) => { + //axios + const objs = { + ...content, + status: data.status, //se presenta con num + statusText: data.statusText, //string + }; + return (objs); + }) + .catch((error) => { + const failObject = { + ...content, + status: error.data ? 404 : 404, + statusText: "FAIL", + }; + return(failObject); + }); + }) + ); +}; +// trueRoute([ +// { +// href: "https://es.wikipedia.org/wiki/Markdown/tania", +// text: "Markdown", +// file: "README.md", +// }, +// ]); + +// estadística de archivos repetidos (en caso de que hayan) console.log(new Set([50,90,30,'veinte', 'ocho', 90,30,'quince'])) //instancia de un modelo existente // set no funciona con lengh si no con size +const statsRep = (allLinks) => { + // me va a devolver un arr de links + const linksAr = allLinks.map((content) => content.href); + const linksU = new Set(linksAr); // me va a dar linsk unicos + return { + total: linksAr.length, + unique: linksU.size, + }; +}; +// console.log(statsRep([ +// { +// href: "https://es.wikipedia.org/wiki/Markdown/tania", +// text: "Markdown", +// file: "README.md", +// }, +// { +// href: "https://es.wikipedia.org/wiki/Markdown/tania", +// text: "Markdown", +// file: "README.md", +// }, +// ])); +//validar links rotos +const brokenLinks = (allLinks) => { + const brokenAr = allLinks.filter((content) => content.statusText === "FAIL"); //filtrar de acuerdo a una condición //devuelve un arr con los rotos + return { + total: allLinks.length, + unique: statsRep(allLinks).unique, + broken: brokenAr.length, + }; +}; +// console.log(brokenLinks([ +// { +// href: "https://es.wikipedia.org/wiki/Markdown/tania", +// text: "Markdown", +// file: "README.md", +// statusText:"FAIL", +// }, +// { +// href: "https://es.wikipedia.org/wiki/Markdown/tania", +// text: "Markdown", +// file: "README.md", +// statusText: "FAIL", +// }, +// ])) + +//obtener archivos md //usar ejemplo readme.md +const addFileMd = (route) => { + if (validPath(route)) { + absolutePath(route); + transformAbs(route); + } + return recursive(route); // devuelve un array con archivos md +}; + +// addFileMd(); +module.exports = { + addFileMd, //obtiene archivos md + routeFalse, //valida ruta false + trueRoute, //valida ruta true + brokenLinks, //valida los links rotos + statsRep, //devuelve stats +}; diff --git a/imgdrawio/drawio1.png b/imgdrawio/drawio1.png new file mode 100644 index 0000000..66a275d Binary files /dev/null and b/imgdrawio/drawio1.png differ diff --git a/imgdrawio/drawio2.png b/imgdrawio/drawio2.png new file mode 100644 index 0000000..5210a1e Binary files /dev/null and b/imgdrawio/drawio2.png differ diff --git a/imgdrawio/drawio3.png b/imgdrawio/drawio3.png new file mode 100644 index 0000000..36a948d Binary files /dev/null and b/imgdrawio/drawio3.png differ diff --git a/index.js b/index.js deleted file mode 100644 index a4e4a45..0000000 --- a/index.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = () => { - // ... -}; diff --git a/mdLinks.js b/mdLinks.js new file mode 100644 index 0000000..16e0f78 --- /dev/null +++ b/mdLinks.js @@ -0,0 +1,66 @@ +const { + addFileMd, + routeFalse, + trueRoute, + brokenLinks, + statsRep +} = require("./function"); //use destructuración para importar funciones +const colors = require('colors'); + +const mdLinks = (path, options) => { + return new Promise((res, rej) => { + if (options[0] === undefined && options[1] === undefined) { + const inputPath = addFileMd(path); + inputPath.map((content) => { + + //map recibe una funct y la funct recibe un elemento a iterar + routeFalse(content) + .then((data) => { + console.log(data); + return res(data); + }) + .catch((error) => { + rej("La ruta ingresada no es válida", error); + }); + }); + } else { + if ( + (options[0] === "--validate" && options[1] === "--stats") || + (options[0] === "--stats" && options[1] === "--validate") + ) { + const inputPath = addFileMd(path); + inputPath.map((content) => { + routeFalse(content).then((data) => { + console.log(brokenLinks(data)) + return res (brokenLinks(data)); + }); + }); + + } else if (options[0] === "--validate") { + const arrMd = addFileMd(path); + arrMd.map((element) => { + routeFalse(element) + .then((data) => { + trueRoute(data).then((data)=> { + console.log(data) + return resolve(data) + } + ); + }) + .catch((error) => { + return reject("La ruta ingresada es válida", error); + }); + }); + } else if (options[0] === "--stats") { + const arrMdStast = obtenerArchivosMd(path); + arrMdStast.map((element) => { + invalidateAllRoutes(element).then((data) => { + console.log(statsFunction(data)); + return resolve(statsFunction(data)); + }); + }); + } + } + }); +}; +module.exports = mdLinks; \ No newline at end of file diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..c4b0bef --- /dev/null +++ b/package-lock.json @@ -0,0 +1,117 @@ +{ + "name": "md-links", + "version": "0.1.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "md-links", + "version": "0.1.0", + "dependencies": { + "axios": "^1.3.4", + "colors": "^1.4.0" + }, + "engines": { + "node": ">=16.x" + } + }, + "node_modules/asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" + }, + "node_modules/axios": { + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.3.4.tgz", + "integrity": "sha512-toYm+Bsyl6VC5wSkfkbbNB6ROv7KY93PEBBL6xyDczaIHasAiv4wPqQ/c4RjoQzipxRD2W5g21cOqQulZ7rHwQ==", + "dependencies": { + "follow-redirects": "^1.15.0", + "form-data": "^4.0.0", + "proxy-from-env": "^1.1.0" + } + }, + "node_modules/colors": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "dependencies": { + "delayed-stream": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/follow-redirects": { + "version": "1.15.2", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz", + "integrity": "sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==", + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/RubenVerborgh" + } + ], + "engines": { + "node": ">=4.0" + }, + "peerDependenciesMeta": { + "debug": { + "optional": true + } + } + }, + "node_modules/form-data": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz", + "integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==", + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/proxy-from-env": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz", + "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==" + } + } +} diff --git a/package.json b/package.json index 5c10b74..6a299c5 100644 --- a/package.json +++ b/package.json @@ -8,5 +8,9 @@ "createdAt": "2022-11-30T13:40:29.636Z", "version": "5.5.0", "commit": "51e941edf1cc991930aefd7dd9c406a7c43741c1" + }, + "dependencies": { + "axios": "^1.3.4", + "colors": "^1.4.0" } -} \ No newline at end of file +} diff --git a/test.drawio b/test.drawio new file mode 100644 index 0000000..21e3928 --- /dev/null +++ b/test.drawio @@ -0,0 +1,754 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file