{"_id":"@camilacunha/md-links","_rev":"1-a81472114019a17efab6e30a44abb25b","name":"@camilacunha/md-links","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@camilacunha/md-links","version":"1.0.0","description":"Biblioteca que lê e analisa arquivos no formato Markdown, para verificar os arquivos que contenham links e mostrar algumas estatísticas.","keywords":["javascript","markdown","node.js","jest"],"author":{"name":"Camila Cunha"},"license":"ISC","scripts":{"start":"node index.js","pretest":"eslint --ext .js ./","test":"jest --coverage"},"repository":{"type":"git","url":"git+https://github.com/camilagerarde/SAP004-md-links.git"},"bugs":{"url":"https://github.com/camilagerarde/SAP004-md-links/issues"},"homepage":"https://github.com/camilagerarde/SAP004-md-links#readme","bin":{"md-links":"cli.js"},"devDependencies":{"eslint":"^7.4.0","install":"^0.13.0","jest":"^26.1.0","prettier":"2.0.5"},"dependencies":{"chalk":"^4.1.0","commander":"^5.1.0","node-fetch":"^2.6.0"},"publishConfig":{"access":"public"},"gitHead":"8db0503597c9de752fea9ce084ea673753c7dabe","_id":"@camilacunha/md-links@1.0.0","_nodeVersion":"12.17.0","_npmVersion":"6.14.6","dist":{"integrity":"sha512-ZAMrTAQ2MVcQ8frHezeBNckE/IbXIyVDXaMzS3YzC3HwWbHdLGk9tE2Pvan06TH1V8BYqtYtqwugblcfZ34r1A==","shasum":"e79e6c5beaed782bcb48644e0ee33b435fc70f82","tarball":"https://registry.npmjs.org/@camilacunha/md-links/-/md-links-1.0.0.tgz","fileCount":9,"unpackedSize":17493,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfDcqGCRA9TVsSAnZWagAAa38P/RIcagsYVD1wK85vIJ5x\nZx8wYieYQrKjEnADTO7OheDKUrqEuxID7iOiFGdn6DnE/xvPG8w9UCQYNq1B\n/5OvuY+2j9H3Qr9aurKQqXNfCtDS85hJeuZ8HglNgsMh5NiCKYUw+L2xGeXL\nSySKX4H+9PyrKzStHeIp0rxw0RDcDVUgsP0EdPi2HH807kZR7vinc2SJppf8\ngtatrDmTlrrn0ss/LE2YTxwbf3CoMyJuf8cj8/fJtB3uT2oVnyYT+viOQH4Z\nWAwNI564UOZ2LIMFOuvW0uzogCaHnWmvKWCVxiYt2/JMKVhCewQ7XhieChey\nmoqPkT4KFx+6Qz3ckHfy6pwhR5k06r/AADkjRVYLlaOjFqfq6sVAhNH6oMEb\nZhp2O+vQ8bIds0E8GC+4SwxIyJ6myKNrt6pw8UE6CxWpU0T8NVLUwppAOY9P\nySQfUrI+kVj7+0rUKLDFaQL5C4WvdMUlQYWKzAioTCNbVImvZBFqgwrn07xc\nS5O7a2xutOYwYfKU4Vmk45VUsHtppOB4V557omEJTw10JnwJWjyYLx5dJgSM\nGUgdJoBVrEzfPfW7KZOY+83JJteEAbu5V/TxG4ZF3LRYScFwPKckbe477QeH\no8dAaCQiNhTt4ZmWmOjAhgHEHvCtMJ+b/r7SVHRvGkTICYJCnHRPVNdqpHXo\nxfMS\r\n=qoHi\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCS3peEE65XP0lRmLGAQaIBDWCYBlTGcTmpyTHKOnMZ2QIgGFhvG3W2pIpa3IgxGqrk+E3yWUtD+Gdvc9CnUvD9gLM="}]},"maintainers":[{"name":"camilacunha","email":"millagerarde@gmail.com"}],"_npmUser":{"name":"camilacunha","email":"millagerarde@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/md-links_1.0.0_1594739333834_0.8159660522821173"},"_hasShrinkwrap":false}},"time":{"created":"2020-07-14T15:08:53.789Z","1.0.0":"2020-07-14T15:08:53.954Z","modified":"2022-04-04T21:34:14.772Z"},"maintainers":[{"name":"camilacunha","email":"millagerarde@gmail.com"}],"description":"Biblioteca que lê e analisa arquivos no formato Markdown, para verificar os arquivos que contenham links e mostrar algumas estatísticas.","homepage":"https://github.com/camilagerarde/SAP004-md-links#readme","keywords":["javascript","markdown","node.js","jest"],"repository":{"type":"git","url":"git+https://github.com/camilagerarde/SAP004-md-links.git"},"author":{"name":"Camila Cunha"},"bugs":{"url":"https://github.com/camilagerarde/SAP004-md-links/issues"},"license":"ISC","readme":"# Markdown Links :link:\n\n[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://forthebadge.com)\n\n## Índice\n\n- [1. Introdução](#1-introdução)\n- [2. Instalação](#2-instalação-computer)\n- [3. Como utilizar](#3-como-utilizar-star)\n- [4. Desinstalação](#4-desinstalação-warning)\n- [5. Considerações gerais](#5-considerações-gerais)\n\n## 1. Introdução\n\n**MD-LINKS** é uma biblioteca _library_ de linha de comando (CLI) em JavaScript que usa [Node.js](https://nodejs.org/), para ler e analisar arquivos no formato `Markdown`, verificar os arquivos que contenham links e mostrar algumas estatísticas.\n\n> [Markdown](https://pt.wikipedia.org/wiki/Markdown) é uma linguagem de marcação muito popular entre os programadores.  \n> É usada em muitas plataformas que manipulam texto (GitHub, fórum, blogs e etc) e é muito comum encontrar arquivos com este formato em qualquer repositório (incluindo este `README.md` que você está lendo agora :blush:).\n\n## 2. Instalação :computer:\n\nNo terminal, digite o comando abaixo:  \n`$ npm install --global camilagerarde/SAP004-md-links`\n\nSe retornar um erro de permissão, tente usar `sudo` antes do comando, dessa forma:  \n`$ sudo npm install --global camilagerarde/SAP004-md-links`\n\n## 3. Como utilizar :star:\n\n### JavaScript API\n\nPara utilizar a biblioteca em um projeto JavaScript, faça o `require` no arquivo desejado.\n\nDessa forma:\n\n```\nconst mdLinks = require(\"md-links\");\n\nmdLinks(\"./exemplo.md\")\n  .then((links) => {\n    // => [{ file, href, text }]\n  })\n  .catch(console.error);\n\nmdLinks(\"./exemplo.md\", { validate: true })\n.then((links) => {\n    // => [{ file, href, text, validate }]\n  })\n  .catch(console.error);\n```\n\n### CLI (Command Line Interface - Interface de Linha de Comando)\n\nUtilize o executável da seguinte maneira, através do terminal:\n\n`$ md-links <path-to-file-or-directory> [options]`\n\n- `path`: Rota absoluta ou relativa para o arquivo, ou diretório.\n- `options`: Um objeto com a seguinte propriedade:\n  - `validate`: Um booleano que determina se deseja validar os links encontrados.\n  - `stats`: Um booleano que determina se deseja verificar estatísticas dos links.\n\n#### Valor de retorno\n\nO retorno será um array de objetos, onde cada objeto representa um link, com as seguintes propriedades:\n\n- `file`: Rota do arquivo onde foi encontrado o link.\n- `url`: URL encontrada.\n- `text`: Texto descritivo do link.\n\nO comportamento padrão identifica o arquivo Markdown (a partir da rota que recebeu como argumento), analisa e retorna os links encontrados, junto com a rota do arquivo e o texto descritivo.\n\n_Por exemplo:_\n\n```sh\n$ md-links ./test\n\nFile: ./test/example.md\nURL: https://pt.wikipedia.org/wiki/Markdown\nText: Markdown\n\nFile: ./test/example.md\nURL: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refere\nText: JavaScript\n```\n\n#### Options\n\n##### `--validate ou -v`\n\nSe incluir a opção `--validate`, o módulo faz uma requisição HTTP para verificar se o link está ativo.\n\n```sh\n$ md-links ./example.md --validate\n\nFile: ./example.md\nURL: https://pt.wikipedia.org/wiki/Markdown\nText: Markdown\nValidate: 200 OK\n\nFile: ./example.md\nURL: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refere\nText: JavaScript\nValidate: 404 Not Found\n\n```\n\n##### `--stats ou -s`\n\nSe incluir a opção `--stats` o _output_ (saída) será um texto com estatísticas (total e únicos) sobre os links.\n\n```sh\n$ md-links ./test --stats\n\nTotal links: 5\nUnique links: 4\n```\n\n##### `--validate --stats ou -v -s`\n\nSe combinadas as opções `--stats` e `--validate` o _output_ será um texto com estatísticas sobre os links, incluindo links \"quebrados\".\n\n```sh\n$ md-links ./test --validate --stats\n\nTotal links: 5\nUnique links: 4\nBroken links: 1\n```\n\n## 4. Desinstalação :warning:\n\nPara desinstalar a biblioteca, utilize o comando:\n\n`$ npm uninstall --global md-links`\n\nou em casos de erro de permissão:  \n`$ sudo npm uninstall --global md-links`\n\nCaso persista o erro utilize o comando, para verificar o nome da pasta onde foi instalada a biblioteca.  \n`$ npm list --global --depth=0`\n\ne utilize:  \n`$ npm uninstall --global <nome-da-pasta>`\n\n## 5. Considerações gerais\n\n### Tecnologias e bibliotecas utilizadas\n\n- [JavaScript](https://developer.mozilla.org/pt-BR/docs/Web/JavaScript)\n- [Node.js](https://nodejs.org/)\n- [commander](https://github.com/tj/commander.js/)\n- [chalk](https://github.com/chalk/chalk)\n- [fs](https://nodejs.org/api/fs.html)\n- [path](https://nodejs.org/api/path.html)\n- [fetch](https://www.npmjs.com/package/node-fetch)\n- [eslint](https://eslint.org/)\n- [jest](https://jestjs.io/)\n\n### Autoria\n\nFeito por [Camila Cunha](https://github.com/camilagerarde), para o Bootcamp da [Laboratória](https://github.com/Laboratoria).\n\n[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)\n","readmeFilename":"README.md"}