{"_id":"nf-conventional-changelog","_rev":"18-f17b53157a5922ec1a1c44063951283e","name":"nf-conventional-changelog","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"nf-conventional-changelog","version":"1.0.0","keywords":["changelog","conventional","generate","release"],"license":"BSD","_id":"nf-conventional-changelog@1.0.0","maintainers":[{"name":"netflix","email":"aliu@netflix.com"}],"contributors":[{"name":"Brian Ford"},{"name":"Vojta Jína"},{"name":"Andrew Joslin"},{"name":"James Womack"}],"homepage":"https://github.com/jameswomack/nf-conventional-changelog#readme","bugs":{"url":"https://github.com/jameswomack/nf-conventional-changelog/issues"},"dist":{"shasum":"e6656b7c552c09670e954fb5f7cff18bf93fadde","tarball":"https://registry.npmjs.org/nf-conventional-changelog/-/nf-conventional-changelog-1.0.0.tgz","integrity":"sha512-u/vFnjmGRVveM9x9OSCFadSKU1smzx44SSTywyC73HUl/7FmEsE5tNwoKFgKS/TlTX7tGaHrpAbRdLQnmuu1IA==","signatures":[{"sig":"MEUCICQQt94/Ciq4MP0Fq0FXSkuKi23RVcQCXhVBu3NEeFXjAiEAmuyUyx1TConkSzNfOWsl8xUCWsqU9AtB4MyLZ0HimUI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"index.js","_from":".","files":["index.js","lib/","test/"],"_shasum":"e6656b7c552c09670e954fb5f7cff18bf93fadde","gitHead":"8f5f908cbd2ac75943f65595c002287db1daeed8","scripts":{"lint":"jshint lib test index.js --exclude node_modules","test":"npm run-script lint && mocha --no-colors","coverage":"istanbul cover _mocha -- -R spec && rm -rf ./coverage"},"_npmUser":{"name":"netflix","email":"aliu@netflix.com"},"repository":{"url":"git+https://github.com/jameswomack/nf-conventional-changelog.git","type":"git"},"_npmVersion":"2.9.1","description":"Generate a changelog from git metadata, using the Netflix DSC commit conventions","directories":{},"_nodeVersion":"0.12.2","dependencies":{"lodash":"3.6.0","dateformat":"1.0.11","event-stream":"3.3.0","github-url-from-git":"1.4.0","normalize-package-data":"1.0.3"},"devDependencies":{"chai":"2.2.0","mocha":"2.2.5","jshint":"2.6.3","istanbul":"0.3.13","coveralls":"2.11.2"}}},"time":{"created":"2015-06-05T18:40:54.334Z","modified":"2025-11-26T16:39:48.977Z","1.0.0":"2015-06-05T18:40:54.334Z"},"bugs":{"url":"https://github.com/jameswomack/nf-conventional-changelog/issues"},"license":"BSD","homepage":"https://github.com/jameswomack/nf-conventional-changelog#readme","keywords":["changelog","conventional","generate","release"],"repository":{"url":"git+https://github.com/jameswomack/nf-conventional-changelog.git","type":"git"},"description":"Generate a changelog from git metadata, using the Netflix DSC commit conventions","contributors":[{"name":"Brian Ford"},{"name":"Vojta Jína"},{"name":"Andrew Joslin"},{"name":"James Womack"}],"maintainers":[{"email":"npm@netflix.com","name":"barb_the_builder"}],"readme":"#  [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status][coveralls-image]][coveralls-url]\n\n> Generate a changelog from git metadata, using the AngularJS commit conventions\n\n\n## Install\n\n```sh\n$ npm install conventional-changelog\n```\n\n- [Synopsis of Conventions in CONVENTIONS.md](https://github.com/ajoslin/conventional-changelog/blob/master/CONVENTIONS.md)\n- [Full Convention Spec on Google Docs](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/)\n\nAdapted from code originally written by @vojtajina and @btford in [grunt-conventional-changelog](https://github.com/btford/grunt-conventional-changelog).\n\n\n## Example output\n\n- https://github.com/ajoslin/conventional-changelog/blob/master/CHANGELOG.md\n- https://github.com/karma-runner/karma/blob/master/CHANGELOG.md\n\n\n## Roadmap\n\n- Make it return a stream\n- Add a proper command line interface\n- Add configurable subjects & sections\n- Split up this repo into smaller modules [#22](https://github.com/ajoslin/conventional-changelog/issues/22)\n\n\n## Documentation\n\nSimple usage:\n\n```js\nrequire('conventional-changelog')({\n  repository: 'https://github.com/joyent/node',\n  version: require('./package.json').version\n}, function(err, log) {\n  console.log('Here is your changelog!', log);\n});\n```\n\n#### `changelog(options, callback)`\n\nBy default, calls the callback with a string containing a changelog from the previous tag to HEAD, using pkg.version, prepended to existing CHANGELOG.md (if it exists).\n\n`callback` is the second parameter, and takes two parameters: `(err, log)`. `log` is a string containing the newly generated changelog, and `err` is either an error or null.\n\n`options` is the first parameter, an object.  The following fields are available:\n\n##### The Most Important Options\n\n* `version` `{string}` - The version to be written to the changelog. For example, `{version: \"1.0.1\"}`. Defaults to the version found in `package.json`. See `pkg` to configure the path of package.json.\n\n* `subtitle` `{string}` - A string to display after the version title in the changelog. For example, it will show '## 1.0.0 \"Super Version\"' if codename '\"Super Version\"' is given. By default, it's blank.\n\n* `repository` `{string}` - If this is provided, allows issues and commit hashes to be linked to the actual commit.  Usually used with github repositories.  For example, `{repository: 'http://github.com/joyent/node'}`. Defaults to \"normalized\" `repository.url` found in `package.json`. See `pkg` to configure the path of package.json.\n\n* `pkg` `{string}` - The path of `package.json`. Defaults to `./package.json`.\n\n* `from` `{string}` - Which commit the changelog should start at. By default, uses previous tag, or if no previous tag the first commit.\n\n* `to` `{string}` - Which commit the changelog should end at.  By default, uses HEAD.\n\n* `file` `{string}` - Which file to read the current changelog from and prepend the new changelog's contents to.  By default, uses `'CHANGELOG.md'`.\n\n##### The \"I really want to get crazy\" Options\n\n* `versionText` `{function(version, subtitle)}` - What to use for the title of a major version in the changelog. Defaults to `'## ' + version + ' ' + subtitle`.\n\n* `patchVersionText` `{function(version, subtitle)}` - What to use for the title of a patch version in the changelog. Defaults to `'### ' + version + ' ' + subtitle`.\n\n* `commitLink` `{function(commitHash)}` - If repository is provided, this function will be used to link to commits. By default, returns a github commit link based on options.repository: `opts.repository + '/commit/' + hash`.\n\n* `issueLink` `{function(issueId)}` - If repository is provided, this function will be used to link to issues.  By default, returns a github issue link based on options.repository: `opts.repository + '/issues/' + id`.\n\n* `log` `{function()}` - What logging function to use. For example, `{log: grunt.log.ok}`. By default, uses `console.log`.\n\n* `warn` `{function()}` - What warn function to use. For example, `{warn: grunt.log.writeln}`. By default, uses `console.warn`.\n\n\n## License\n\nBSD\n\n\n[npm-image]: https://badge.fury.io/js/conventional-changelog.svg\n[npm-url]: https://npmjs.org/package/conventional-changelog\n[travis-image]: https://travis-ci.org/ajoslin/conventional-changelog.svg?branch=master\n[travis-url]: https://travis-ci.org/ajoslin/conventional-changelog\n[daviddm-image]: https://david-dm.org/ajoslin/conventional-changelog.svg?theme=shields.io\n[daviddm-url]: https://david-dm.org/ajoslin/conventional-changelog\n[coveralls-image]: https://coveralls.io/repos/ajoslin/conventional-changelog/badge.svg\n[coveralls-url]: https://coveralls.io/r/ajoslin/conventional-changelog\n","readmeFilename":"README.md"}