{"_id":"@carolgmonteiro/md-links","_rev":"1-1859005249a33378c014a07b692660d8","name":"@carolgmonteiro/md-links","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@carolgmonteiro/md-links","version":"1.0.0","description":"Software that analizes links from markdown files","main":"./index.js","bin":{"md-links":"./index.js"},"publishConfig":{"access":"public"},"scripts":{"test":"jest --coverage"},"repository":{"type":"git","url":"git+https://github.com/carolgmonteiro/SCL010-md-links.git"},"keywords":["md","npm","library","libreria","livraria","markdown","links","node.js","javascript"],"author":{"name":"Carolina Guido Monteiro"},"license":"ISC","bugs":{"url":"https://github.com/carolgmonteiro/SCL010-md-links/issues"},"homepage":"https://github.com/carolgmonteiro/SCL010-md-links#readme","dependencies":{"chalk":"^2.4.2","commander":"^3.0.1","fetch":"^1.1.0","filehound":"^1.17.3","marked":"^0.7.0","node-fetch":"^2.6.0"},"directories":{"test":"test"},"devDependencies":{"eslint":"^6.2.1","eslint-plugin-jest":"^22.15.2","jest":"^24.9.0"},"gitHead":"b5a4926facd1e8695378769f7e130762832a8a54","_id":"@carolgmonteiro/md-links@1.0.0","_nodeVersion":"10.16.0","_npmVersion":"6.9.0","dist":{"integrity":"sha512-u/HXiAlk+YM2pUBiBivwhPx4G7YO/suK4zb+CwqzxjAJB55JuMMhHQh07k11hbN8bEy/pf3junUn8mqgcI0vzA==","shasum":"0f9a9dedea6a43b86bfd355c04f172db66d75c6c","tarball":"https://registry.npmjs.org/@carolgmonteiro/md-links/-/md-links-1.0.0.tgz","fileCount":10,"unpackedSize":23572,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdcq4ZCRA9TVsSAnZWagAAzSEQAIBKGhpCUh0bE8h8GcB7\n6CMckkJMgu1+hmtDk8tk1Krk/Pp+Ss2M7SH2yUt5L36lstUTVu52GOmaVLoA\nWbVQTM3nrAyiCXo6UlRhf2WIp/y/PDPtw7mdDXzvDGxTxxB5hjGeUKEiTavZ\nKI6RtWrCcd/KZ75JdxpeGrtF7WvNyDQ/+XINC/YqCxNvAc5p5Nx+JJ6oxeas\nWi3Gn6yQZDUNYSSH+E+faCCMedY3ktL1v5mnX88b8LM8Gx3itNWyLXCkfH80\nA1aKZFNosI7ilwSnKIM38guVeQwCql5ckK8z4oShLvm9uY/xRWnRaMle/qP7\nnO9l4QUb44u62zXzyNNjPHCkMFXqFymWmwHtQEOMdlTa4bpw7eKjGkbJO/bH\nVvnmpKM/Cjshw20V7LKLs+0+0CLFVgGGuOPLtMXbvn7CnO58hi3VD56Vl79D\nrzjydLYsAE7wuOBTBP1tVASAm4DqJ5VH7pIpBLW3iJooLBXWdkbl+E/XGzAG\n8l8tNXZ2+hKXIiMeLLRRDrvL6Wxn/cxlhhbB/AFLgtfy0fIq36EAzR3NgecF\nBIlFfd8m78uPFYudeemXb1tW7t7mSJxyDm9ISwmiHTOtxZIygONOoNN9YTE/\ndwIlPI7HBMJXoEGPdLwHj1ze2foTNd58uAQ/0ZqIJ/VtOssOIeafAvdlwNo/\nfkne\r\n=Y+AX\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIALoaA2pqM+lUlng2eT23iNx08A9VDvGqb1WEtq5OpJ5AiAnmmPvOa9dldfb0jByc/rrxRv4ZgzGQTZX/xXJLYQdJQ=="}]},"maintainers":[{"name":"carolgmonteiro","email":"carolgmonteiro@live.com"}],"_npmUser":{"name":"carolgmonteiro","email":"carolgmonteiro@live.com"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/md-links_1.0.0_1567796761212_0.5082706532267203"},"_hasShrinkwrap":false}},"time":{"created":"2019-09-06T19:06:01.002Z","1.0.0":"2019-09-06T19:06:01.330Z","modified":"2022-04-04T21:58:43.909Z"},"maintainers":[{"name":"carolgmonteiro","email":"carolgmonteiro@live.com"}],"description":"Software that analizes links from markdown files","homepage":"https://github.com/carolgmonteiro/SCL010-md-links#readme","keywords":["md","npm","library","libreria","livraria","markdown","links","node.js","javascript"],"repository":{"type":"git","url":"git+https://github.com/carolgmonteiro/SCL010-md-links.git"},"author":{"name":"Carolina Guido Monteiro"},"bugs":{"url":"https://github.com/carolgmonteiro/SCL010-md-links/issues"},"license":"ISC","readme":"# Md-Links | Libreria para extraer links de archivos Markdown\r\n\r\nMarkdown es un lenguaje de marcado ligero muy popular entre developers. Es usado en muchas 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).\r\n\r\nEstos 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.\r\n\r\nLa libreria, que está en el idioma inglés, fue creada usando [Node.js](https://nodejs.org/), e su función es leer y analizar archivos en formato `Markdown` desde el input de un unico archivo hasta un directorio. Extrae links de los archivos y los verifica el status de los links y saca estadísticas cómo total de links, links que no funcionan y unicos.\r\n\r\n# Guía de Uso e Instalación\r\n\r\n## Instalación\r\n\r\n```js\r\nconst mdLinks = require(\"cgm-md-links\");\r\n```\r\n\r\nCon el comando `npm install cgm-md-links` podemos instalar directamente. Ver [docs oficiales de `npm install` acá](https://docs.npmjs.com/cli/install).\r\n\r\n```\r\nnpm install cgm-md-links\r\n```\r\n\r\n## Como usar\r\n\r\nEn el archivo JS:\r\n\r\n```js\r\nconst mdlinks = require(\"cgm-md-links\");\r\n```\r\n\r\n---\r\n\r\n**Cómo llamar a libreria desde la terminal:**\r\n\r\n- Para path-to-file igual a un Directorio\r\n\r\n```\r\nmd-links <\"path-to-directory\"> [options]\r\n```\r\n\r\n- Para path-to-file igual a un archivo\r\n\r\n```\r\nmd-links <\"path-to-file\"> [options]\r\n```\r\n\r\n---\r\n\r\n**CLI (Command Line Interface)**\r\n\r\nLa libreria hace las seguientes entregas:\r\n\r\n**1.** El usuario no elije ninguna opción y recibe los links extraiedos de los archivos analizados\r\n\r\n**2.** Elije las opciones disponibles:\r\n\r\n- **stats** (dados estadisticos de los links)\r\n- **validate** (status de los links en la red)\r\n- **stats validate** (dados estadisticos del status de los links)\r\n\r\n**PATH**\r\n\r\n- Leer archivos con extensión .md\r\n\r\n`md-links `\r\n\r\n\"SIN-OP-FILE\"\r\n\r\n- Leer un directorio\r\n\r\n`md-links <\"path-to-directory\">`\r\n\r\n\"SIN-OP-DIRECTORY\"\r\n\r\nEn ambos casos, se obtiene como resultado:\r\n\r\n- `file`: archivo o ruta donde fue encontrado el link.\r\n- `text`: descripción del link.\r\n- `href`: link encontrado.\r\n\r\n**OPTIONS**\r\n\r\n**--validate**\r\n\r\nEntrega la validacion o status de los links (status: 200, 300, 404, 500 etc).\r\n\r\nUsar así `md-links <\"path-to-file\"> --stats`\r\n\r\n\"VALIDATE-OP-FILE\"\r\n\r\n**--stats**\r\n\r\nEntrega las seguientes estadísticas de los links:\r\n`Total -` el total de links encontrados;\r\n`Unique -` el total de links unicos.\r\n\r\nUsar así\r\n`md-links <\"path-to-directory\"> --stats --validate`\r\n`md-links <\"path-to-file\"> --stats`\r\n`--stats` | `--s`\r\n\r\n\"STATS-OP-FILE\"\r\n\r\n**--stats --validate**\r\n\r\nEntrega las seguientes estadísticas de los links:\r\n`Total -` el total de links encontrados;\r\n`Unique -` el total de links unicos.\r\n`Broken -` el total de links rotos;\r\n\r\nUsar así\r\n`md-links <\"path-to-directory\"> --stats --validate`\r\n`md-links <\"path-to-file\"> --stats --validate`\r\n`--stats --validate` | `--validate --stats` | `--s --v` | `--v --s`\r\n\r\n\"STATS-VALIDATE-OP-FILE\"\r\n\r\n---\r\n\r\n## Documentación técnica\r\n\r\n### Dependencias:\r\n\r\n- node.js versión 11\r\n- \"chalk\": \"^2.4.2\"\r\n- \"fetch\": \"^1.1.0\"\r\n- \"filehound\": \"^1.17.3\"\r\n- \"marked\": \"^0.7.0\",\r\n- \"node-fetch\": \"^2.6.0\"\r\n- \"eslint\": \"^6.2.1\",\r\n- \"eslint-plugin-jest\": \"^22.15.2\",\r\n- \"jest\": \"^24.9.0\"\r\n\r\n---\r\n\r\n### Planificación:\r\n\r\n**Diagrama de Flujo**\r\n\r\n\"Slide2\"\r\n\r\n**Trello**\r\n\r\nEl board con el backlog de la implementación de la librería puede ser encontrado [aquí.](https://trello.com/b/igGvDu6L)\r\n\"Slide11\"\r\n\r\n**Milestones del proyecto**\r\n\r\nEl proyecto fue ordenado en milestones en trello, recorriendo cada parte del diagrama de flujo\r\n\r\n\"Slide3\"\r\n\"Slide4\"\r\n\"Slide5\"\r\n\"Slide6\"\r\n\"Slide7\"\r\n\"Slide8\"\r\n\"Slide9\"\r\n\"Slide10\"\r\n\"Slide11\"\r\n\"Slide12\"\r\n\r\n---\r\n\r\n## Autora\r\n\r\n[Carolina Guido Monteiro](https://github.com/carolgmonteiro)\r\nDesarrolladora Front-end\r\n\r\n---\r\n","readmeFilename":"README.md"}