{"bin":{"conventional-changelog":"cli.js"},"bugs":{"url":"https://github.com/conventional-changelog/conventional-changelog/issues"},"dist":{"shasum":"73d0507a4d100c7975418b8ca4db2d489fa0d35e","tarball":"https://registry.npmjs.org/conventional-changelog-cli/-/conventional-changelog-cli-2.0.22.tgz","fileCount":5,"integrity":"sha512-aLUQmyomfXV0xauIpQtsLPXnqZMumm4+1P6Mv2CjrlKF8XQ8Jn1LnMUScaLnqvDOzeGIMwPIY5DVA7hGFD6ddw==","signatures":[{"sig":"MEUCIH47fZgIc7jXPaj8g54cAwXAG4agPsl8AOXfqU9TPyqmAiEA29YRZU1rsp7Xb3pTrjOlJpffV9K7w6D7gUPQOznU1w0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":28537,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc4G/cCRA9TVsSAnZWagAA5OIP+gPiMUYjvvNFwF0lvW2G\n5/JO1XmOqcF13w8RLsLRUDSmeDgfEoRvjoDmlwPk8UsOjjQLe7H+vtJHr4Jx\nSTazr5sNYsHDiDAQnSwLq6O/3BMgrhP8sT7tThDtataml9TUZ0vkpNP/NQwD\nTFP8PPiJMoy7Zy/zLRCc8sXBkuhFPlubQhlLQj9xICpaKrLjxQTboAiMlAhd\nsfG/4kzCidXF+1SrGxHyFnrl3x66SU2pJ3iSBnEfi4GqmeSojHBtpjRp0TNJ\nE3jqkK833JiNarC/H1ORfQhKcZuygwFQwL4BqvUfEZYVRYea1QIX++wF4HZQ\nTc7z1JMVOvq1OfphaOqxzzKoRw3d/gFKY8PHPIRQN/Fffp/eWI70EIL1hR3c\nj6A+0NB64qI/jOb2J3RGSnKWx83ZTogyVP9gx94sN2WesxwhWs29nxzgwrVY\neA+ttyyfuGXOjrKZ5GpEjx7gnz7PjNBpI0VUKd9VK1AaeybD0u5Dre7TMJtt\nSxbnMSfrnTyGi2lVvZr3BM5DuL38EGsVcKyfkMNifsttRS83ASI9Fyci2Tp4\ncmlzwtCGxBmnWVdlV+4ZqrX4x7sLXNa4TdP1QGbmmzRQwJKYhxmXnb0zr8PY\n12kWLLFD+6xgo9gKXCWm/3hby1X6rikrcrmpoq5G2vZRlrsUKi3Nd+dj4T2h\nglU1\r\n=D/Gx\r\n-----END PGP SIGNATURE-----\r\n"},"name":"conventional-changelog-cli","author":{"url":"https://github.com/stevemao","name":"Steve Mao","email":"maochenyan@gmail.com"},"readme":"# conventional-changelog-cli\n\n[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]\n\n> Generate a changelog from git metadata\n\n*[Changelog?](https://speakerdeck.com/stevemao/compose-a-changelog)*\n\n**Note** You don't have to use the angular commit convention. For the best result of the tool to tokenize you commit and produce flexible output, it's recommended to use a commit convention.\n\n\n## Quick start\n\n```sh\n$ npm install -g conventional-changelog-cli\n$ cd my-project\n$ conventional-changelog -p angular -i CHANGELOG.md -s\n```\n\nThis will *not* overwrite any previous changelog. The above generates a changelog based on commits since the last semver tag that match the pattern of a \"Feature\", \"Fix\", \"Performance Improvement\" or \"Breaking Changes\".\n\nIf you first time use this tool and want to generate all previous changelog, you could do\n\n```sh\n$ conventional-changelog -p angular -i CHANGELOG.md -s -r 0\n```\n\nThis *will* overwrite any previous changelog if exist.\n\nAll available command line parameters can be listed using CLI: `conventional-changelog --help`.\n\n**Hint:** You can alias your command or add it to your package.json. EG: `\"changelog\": \"conventional-changelog -p angular -i CHANGELOG.md -s -r 0\"`.\n\nTo fully customize the tool, please checkout [conventional-changelog](https://github.com/ajoslin/conventional-changelog) and [conventional-changelog-core](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core) docs. You can find more details there. **Note: `config` here can work with `preset`, which is different than `options.config` in conventional-changelog.**\n\n\n## Example output\n\n- https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog/CHANGELOG.md\n- https://github.com/karma-runner/karma/blob/master/CHANGELOG.md\n- https://github.com/btford/grunt-conventional-changelog/blob/master/CHANGELOG.md\n\n\n## Recommended workflow\n\n1. Make changes\n1. Commit those changes\n1. Make sure Travis turns green\n1. Bump version in `package.json`\n1. `conventionalChangelog`\n1. Commit `package.json` and `CHANGELOG.md` files\n1. Tag\n1. Push\n\nThe reason why you should commit and tag after `conventionalChangelog` is that the CHANGELOG should be included in the new release, hence `gitRawCommitsOpts.from` defaults to the latest semver tag.\n\n\n### With `npm version`\n\nUsing the npm scripts to our advantage with the following hooks:\n\n```json\n{\n  \"scripts\": {\n    \"version\": \"conventional-changelog -p angular -i CHANGELOG.md -s && git add CHANGELOG.md\"\n  }\n}\n```\n\nYou could follow the following workflow\n\n1. Make changes\n1. Commit those changes\n1. Pull all the tags\n1. Run the [`npm version [patch|minor|major]`](https://docs.npmjs.com/cli/version) command\n1. Push\n\nYou could optionally add a `preversion` script to package your project or running a full suit of test.\nAnd a `postversion` script to clean your system and push your release and tags.\n\nBy adding a `.npmrc` you could also automate your commit message and set your tag prefix as such:\n\n```\ntag-version-prefix=\"\"\nmessage=\"chore(release): %s :tada:\"\n```\n\n\n## Why\n\n- Used by AngularJS, JSHint and related projects.\n- Easy fully automate changelog generation. You could still add more points on top of it.\n- Ignoring reverted commits, templating with [handlebars.js](https://github.com/wycats/handlebars.js) and links to references, etc. Open an [issue](../../issues/new) if you want more reasonable features.\n- Intelligently setup defaults but yet fully configurable with presets of [popular projects](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog#preset).\n- Everything internally or externally is pluggable.\n- A lot of tests and actively maintained.\n\n### Problems with [github-changelog-generator](https://github.com/skywinder/github-changelog-generator) or similar projects\n\n- Opinionated on how to write commits, issues or PRs.\n- No or partially support reference links.\n- Not system agnostic. Only support GitHub.\n- No template support. The output is mostly certain format of markdown.\n- No presets of popular commit message conventions.\n- Not modularized. Over the years [modularization is proven to be the best practice](https://github.com/sindresorhus/ama/issues/10#issuecomment-117766328).\n- No tests or coverage is too low. Program might be buggy.\n- Do not read your project's environment.\n- No or few task runner or build tool integrations.\n\n\n## API\n\nPlease use [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) \n\n\n## License\n\nMIT © [Steve Mao](https://github.com/stevemao)\n\n\n[npm-image]: https://badge.fury.io/js/conventional-changelog-cli.svg\n[npm-url]: https://npmjs.org/package/conventional-changelog-cli\n[travis-image]: https://travis-ci.org/conventional-changelog/conventional-changelog-cli.svg?branch=master\n[travis-url]: https://travis-ci.org/conventional-changelog/conventional-changelog-cli\n[daviddm-image]: https://david-dm.org/conventional-changelog/conventional-changelog-cli.svg?theme=shields.io\n[daviddm-url]: https://david-dm.org/conventional-changelog/conventional-changelog-cli\n[coveralls-image]: https://coveralls.io/repos/conventional-changelog/conventional-changelog-cli/badge.svg\n[coveralls-url]: https://coveralls.io/r/conventional-changelog/conventional-changelog-cli\n","engines":{"node":">=6.9.0"},"gitHead":"38f5508191f8afc1a8503d1fd24e2de6d05b8738","license":"MIT","scripts":{"test-windows":"echo 'make work on windows'"},"_npmUser":{"name":"bcoe","email":"bencoe@gmail.com"},"homepage":"https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli#readme","keywords":["cli","cli-app","conventional-changelog","conventional","changelog","log"],"deprecated":"This package is no longer maintained. Please use the conventional-changelog package instead.","repository":{"url":"git+https://github.com/conventional-changelog/conventional-changelog.git","type":"git"},"_npmVersion":"lerna/3.13.4/node@v11.12.0+x64 (darwin)","description":"Generate a changelog from git metadata","directories":{},"maintainers":[{"name":"bcoe","email":"bencoe@gmail.com"},{"name":"dlmr","email":"gustaf.dalemar@gmail.com"},{"name":"hutson","email":"hutson@hyper-expanse.net"},{"name":"marionebl","email":"hello@mario-nebl.de"},{"name":"stevemao","email":"maochenyan@gmail.com"},{"name":"tapppi","email":"moilanen.tapani@gmail.com"}],"_nodeVersion":"11.12.0","dependencies":{"meow":"^4.0.0","lodash":"^4.2.1","tempfile":"^1.1.1","add-stream":"^1.0.0","conventional-changelog":"^3.1.9"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/conventional-changelog-cli_2.0.22_1558212571803_0.9567109023692557","host":"s3://npm-registry-packages"},"_id":"conventional-changelog-cli@2.0.22","version":"2.0.22"}