{"_id":"@captalys-platform/changelog-generator","_rev":"26-99beb781c18046b09907b6e60ef73e09","name":"@captalys-platform/changelog-generator","dist-tags":{"latest":"1.2.0"},"versions":{"1.0.0":{"name":"@captalys-platform/changelog-generator","version":"1.0.0","description":"Changelog generator for NodeJs projects","bin":{"generate-changelog":"generate-changelog-md.js","log":"prompt-log.js"},"author":{"name":"Captalys Team"},"license":"ISC","dependencies":{"date-fns":"^2.21.1","inquirer":"^8.0.0"},"_id":"@captalys-platform/changelog-generator@1.0.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.10","dist":{"integrity":"sha512-4BB0kimbb6/TgDzOD/ly6YvEHtoxFa3AtUno/hoyg9K85oabpErQ2QRRVTpseAZDkd5KCFTMFLxemg3aehJi+w==","shasum":"0e53316a8ea6bd2bb40416e166682e2c3e47ee33","tarball":"https://registry.npmjs.org/@captalys-platform/changelog-generator/-/changelog-generator-1.0.0.tgz","fileCount":14,"unpackedSize":20208,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJghIqJCRA9TVsSAnZWagAA0xMP/jUG60Zf7JVGj7RH8SY6\nZTARRaWjOZ7vc4jnFsd56QsLr9ikheOJFn2Xjb69zlLTIG+v/jJJwJLcyjO2\n8PpurVy7IBXtetedoai1vGHvLP34BgdF+ZHPlRnlyDJHh4dgl+pzjLJsj+/J\nwgpXGE+dxIjRyoHYRnAAOSJUOLMTYmfTNkPzP5tWjgjM6ghE6SdlezYENwRx\npkVqgjB91VLwi4Qu/SrZ7NbzI/Ud0EmXBEzNijdQFFelWKH3lrH/stVtSphw\neakrJgFGl/g5p1zIp/Tl5knMoP0jmNnYsDAbnfzoy5JraIJhYYyOilaCPk91\ngS1+36vS4eN4oV09VX+qMCTk6sFRFfsKZK6KVLXP3PCHHVhpCmXg1ci7Qq2T\nJsCF40odnO3IFNyZrPgBZ9ygAMn4zAIE9OdytMsAoSEj8Ql0a99f2h98/AuV\nmXqwGwHE/37MtkYW5Aqy7aV40nWbib2xn7bx9yNnDHXja9+WHNNMSRocR2Z0\nr5bSwpnuXqEQwrJPQKQlwaKNwamT27GNANUTm6MIOdLhE8/kKvPvuWiri5z6\nkI0erRphfumA3TJmCljaHvSGLSsdgivrpbT7FXc95Xxrv13GzhuhpIZVL/bu\n/gEcTgDLtJWgVri1Gf1bOAaj8IcIxajdTFAkTxzXuB+r/ITuDEy57i+8Heov\nTofY\r\n=5Hdg\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAiL4foSyS9tPtsn6JlnrFkZSPz/e5EdF6mIFKT3SbnfAiA9aBwDcoaCNO5fpMqitrONxsIXXSvaCkgU0Ttk63e/vg=="}]},"_npmUser":{"name":"patrick.dias","email":"patrick.dias@captalys.com.br"},"directories":{},"maintainers":[{"name":"rodsdev","email":"rodolfo.vieira@captalys.com.br"},{"name":"patrick.dias","email":"patrick.dias@captalys.com.br"},{"name":"captalys","email":"frontend@captalys.com.br"},{"name":"samu_monteiro","email":"samuel.pinho@fatec.sp.gov.br"},{"name":"carlosqsilva","email":"carlosqsilva@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/changelog-generator_1.0.0_1619298952494_0.4686577102897369"},"_hasShrinkwrap":false},"1.0.2":{"name":"@captalys-platform/changelog-generator","version":"1.0.2","description":"Changelog generator for NodeJs projects","scripts":{"release":"npm publish --access public"},"bin":{"generate-changelog":"generate-changelog-md.js","log":"prompt-log.js"},"author":{"name":"Captalys Team"},"license":"ISC","dependencies":{"date-fns":"2.21.1","inquirer":"8.0.0"},"_id":"@captalys-platform/changelog-generator@1.0.2","_nodeVersion":"15.5.1","_npmVersion":"7.3.0","dist":{"integrity":"sha512-Tmt8wB3nxRgx/2BWwhHHVID5nH5RJCzYSk/acloCI5qJihuooTCMmHaaEu6jqDNkOldzA7fs9HM5aNjMhlkSSQ==","shasum":"dab441f81c5695f1cbef03b6dff00b1a91b59aa5","tarball":"https://registry.npmjs.org/@captalys-platform/changelog-generator/-/changelog-generator-1.0.2.tgz","fileCount":14,"unpackedSize":20399,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICn0mO465E+R1INMdFr8WnBVfM4sQHNivG4P4ZDOw9q7AiAlTsSlOkWOSo7WheBfBVaCjJ6uqLh8icw0WB7aWSm6cQ=="}]},"_npmUser":{"name":"captalys","email":"frontend@captalys.com.br"},"directories":{},"maintainers":[{"name":"murillo_almeida","email":"murillo.almeida@captalys.com.br"},{"name":"rodolfoviolla","email":"rodolfo.violla@captalys.com.br"},{"name":"alexandredrossetto","email":"alexandre.rossetto@captalys.com.br"},{"name":"bruna_pol","email":"bruna.polonio@captalys.com.br"},{"name":"captalys","email":"frontend@captalys.com.br"},{"name":"carlosqsilva","email":"carlosqsilva@outlook.com"},{"name":"rodsdev","email":"rodolfo.vieira@captalys.com.br"},{"name":"gabrielesnackcaptalys","email":"gabriel.esnack@captalys.com.br"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/changelog-generator_1.0.2_1632874313625_0.20933830012674992"},"_hasShrinkwrap":false},"1.2.0":{"name":"@captalys-platform/changelog-generator","version":"1.2.0","description":"Changelog generator for NodeJs projects","scripts":{"prebuild":"rimraf ./lib","build":"node ./esbuild","prepare":"yarn build","release":"npm publish --access public"},"bin":{"generate-changelog":"lib/generate-changelog-md.js","log":"lib/prompt-log.js"},"author":{"name":"Captalys Team"},"license":"ISC","dependencies":{"date-fns":"2.21.1","inquirer":"8.0.0","semver":"^7.3.5"},"devDependencies":{"@types/inquirer":"^8.1.3","@types/node":"^16.11.11","@types/semver":"^7.3.9","esbuild":"0.14.1","rimraf":"^3.0.2"},"gitHead":"2e2a3462c230a095ff74abf67cc8127b6bcfd8af","_id":"@captalys-platform/changelog-generator@1.2.0","_nodeVersion":"14.16.1","_npmVersion":"6.14.12","dist":{"integrity":"sha512-8l7W9k4Kkp7gHO893nsomBvHl0oeFEN8tKNnqJTzjoL7u8dsqJVAsDSjzu7eDRL87B7+O5FSronjhV4VkNSamw==","shasum":"d7dc8ae65abf7c8a172967b72e286b1c279bb376","tarball":"https://registry.npmjs.org/@captalys-platform/changelog-generator/-/changelog-generator-1.2.0.tgz","fileCount":4,"unpackedSize":14605,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhr8WzCRA9TVsSAnZWagAAGxwP/RMgtKyUjrHjdXLd2JIv\np4JFy73ZmpQR/FNo1xz+u8w3MpVt4Z6nYjdjyryWjnRy5nsaqNktyceQqgQ4\n6x6zDVJCpYjJayk73qfaAf1SMqT6tG1PZR2aduQklQprXRjQuy2fgfMN0/cr\nMjTpQN/F0KOwjkNOtvwJeX2JBy8d8WrT6xlfcneouoPxXSAMg8aVCkKphzKG\nOTtumJ0njfMCO2RqnLTG68drNWUfvxKtlc0s0idA47rKi5agMo7EiD91gZQK\nj6Yn3yy/jC+jQrmZQ/1FX+aHxbLRlbMzPhilVIHDkyjeaL35PoARq34zJU/C\nRuW/ngcvGDObi24siPKp4negSK05L53vYP2XBt4sGqHZcd484kpnOLABVthu\n35FAdN6+7WQyaFWV2l8Q2FAXI/PexNnnOc2KSUS/kZdVAZI6L9NudjHqIj6b\nDUHfrMsSETNlE44BzuF3nu91ifJIp0ECNXzSFefgCr688n9cSrSJqf3lvhAd\n9P7rNRXO0uWb8GnKZkcvSbGWQUAZV0GIgqmkgVqkaDiUxyP40lKLrjjWatLA\nhvP4FqIkCVj3yHocVWh9waS3B+r8upcdF9WU1zkTDhEQqEuN9m0dPm+dYh1S\nQQL8VeS9heRzBijU7Neiw6SjGFe8KBhfpESaprVVG31hVfSlu2lexo+gOCec\ng4oI\r\n=YMZi\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIG4agpYF+3jf9zGTGqBVAUeax4zDYisWYDkkKtEwCWOgAiAzQiDzYWP8KxRQ2VoDRfl9QapLcxsPRc4INcQ/nONS7g=="}]},"_npmUser":{"name":"gabrielesnackcaptalys","email":"gabriel.esnack@captalys.com.br"},"directories":{},"maintainers":[{"name":"fernando.barros","email":"fernando.barros@captalys.com.br"},{"name":"rodolfoviolla","email":"rodolfo.violla@captalys.com.br"},{"name":"captalys","email":"frontend@captalys.com.br"},{"name":"carlosqsilva","email":"carlosqsilva@outlook.com"},{"name":"gabrielesnackcaptalys","email":"gabriel.esnack@captalys.com.br"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/changelog-generator_1.2.0_1638909363258_0.4435086690957071"},"_hasShrinkwrap":false}},"time":{"created":"2021-04-24T21:15:52.167Z","1.0.0":"2021-04-24T21:15:52.680Z","modified":"2023-07-11T12:58:36.597Z","1.0.2":"2021-09-29T00:11:53.770Z","1.2.0":"2021-12-07T20:36:03.375Z"},"maintainers":[{"email":"poligono@poligonocapital.com.br","name":"poligono"},{"email":"lsoares@poligonocapital.com.br","name":"laos"}],"description":"Changelog generator for NodeJs projects","author":{"name":"Captalys Team"},"license":"ISC","readme":"# Changelog Generator\n\nGerador de changelogs de versão para aplicações da Captalys.\n\n## Como utilizar\n\nSão dois scripts: um para o fluxo normal de desenvolvimento, no caso um log por MR / issue. O outro script é para gerar o arquivo `CHANGELOG.md` de fato, e será utilizado somente por um `mantainer` do projeto através das branchs permitidas que são configuradas no `config.json` no campo `allowed-branchs`.\n\n### Como adicionar um novo LOG\n\nO desenvolvedor deverá executar o seguinte comando sem **NENHUM** parâmetro:\n\n```\nyarn log\n```\n\nO prompt irá perguntar o nome do pacote - caso tenha um arquivo chamado `lerna.json` no root do projeto - (será um select, não precisa digitar), categoria (que também será um select), título para o log e o número da issue. Ele também irá perguntar o autor, que será default o nome do usuário GIT Local e a versão do log, que será default o valor do `version` do `package.json` do pacote escolhido.\n\nApós o arquivo ser gerado, o desenvolvedor deverá adicionar o novo arquivo normalmente como qualquer outro e não precisará fazer mais nada em relação a `CHANGELOG`.\n\n---\n\nO arquivo gerado terá o nome seguindo a nomenclatura:\n\n`|files.length|-|Date.now()|-|branchName|.json`\n\nEntão por exemplo, caso exista 100 arquivos de log, e a branch atual se chame `feature/changelog-generator`, o nome do arquivo seria:\n\n`101-1614459743670-feature-changelog-generator.json`\n\nLembrando que: é feito um `replace` no nome da branch, substituindo todas os `/` por `-` e evitando nomes inválidos para pastas.\n\nCaso seja necessário, o desenvolvedor poderá alterar manualmente o arquivo e fazer o commit de qualquer alteração como um arquivo comum. O arquivo gerado será sempre o ÚLTIMO da pasta, por questão do número de arquivos atualmente ser igual o primeiro caractere do nome do novo arquivo. Dessa maneira fica mais fácil encontrar o arquivo caso necessário.\n\n---\n\n### Como gerar o arquivo `CHANGELOG.md`\n\nPrimeiro o desenvolvedor deverá estar dentro das branchs permitidas, que são configuradas dentro do `config.json` no campo `allowed-branchs`, caso o contrário o script é encerrado. Dessa maneira é evitado que seja feito commit de alterações do CHANGELOG em branchs de desenvolvimento, gerando conflito e continuando o problema dos Merge Request.\n\nDepois basta executar o seguinte comando:\n\n```\nyarn generate-changelog\n```\n\nO script será executado, perguntará a `releaseDate` (sendo por padrão a data da próxima terça - podendo ser o dia atual) e alterará o arquivo `CHANGELOG.md`, e só precisará ser adicionado e enviado o Commit da forma normal.\n\n## Como configurar os templates do changelog\n\nDentro da pasta `/changelog/templates` deverão existir **obrigatoriamente** 3 arquivos:\n\n### `category-content-template.md`\n\n**Tags obrigatórias do template:**\n\n- `{emojiName}`: emoji que aparecerá no GitLab ao lado do nome da categoria\n- `{categoryLabel}`: categoria do log\n- `{categoryLogs}`: todos os logs de uma categoria\n\n### `package-template.md`\n\n**Tags obrigatórias do template:**\n\n- `{packageName}`: nome do pacote do log (caso seja monorepo)\n- `{projectUrl}`: url do projeto\n- `{logVersion}`: versão do log\n- `{categoriesContent}`: todas as categorias com seus logs\n\n### `version-template.md`\n\n**Tags obrigatórias do template:**\n\n- `{releaseDate}`: data de release dos logs\n- `{packageContent}`: todos os pacotes com todas as categorias e logs\n\nDesde que tenha as tags necessárias com `{}` em volta delas sem espaço, a ordem e disposição pode ser qualquer uma.\n\n## Licença\n\n© 2021 Captalys - Todos os direitos reservados.\n","readmeFilename":"README.md"}