{"_id":"stringify-changelog","_rev":"106597","name":"stringify-changelog","description":"Generate a markdown-formatted changelog from an object, array, yaml or json file.","dist-tags":{"latest":"0.2.1"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"time":{"modified":"2021-06-03T10:38:39.000Z","created":"2015-03-16T13:48:45.502Z","0.2.1":"2016-07-21T09:56:54.658Z","0.2.0":"2016-07-21T09:18:57.636Z","0.1.6":"2016-07-21T06:52:01.738Z","0.1.5":"2016-07-21T06:33:21.591Z","0.1.4":"2016-07-21T06:18:06.396Z","0.1.3":"2016-07-21T06:15:45.780Z","0.1.1":"2015-08-01T05:25:57.820Z","0.1.0":"2015-03-16T13:48:45.502Z"},"users":{"leonzhao":true},"author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/stringify-changelog.git"},"versions":{"0.2.1":{"name":"stringify-changelog","description":"Generate a markdown-formatted changelog from an object, array, yaml or json file.","version":"0.2.1","homepage":"https://github.com/jonschlinkert/stringify-changelog","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/stringify-changelog.git"},"bugs":{"url":"https://github.com/jonschlinkert/stringify-changelog/issues"},"license":"MIT","files":["index.js","LICENSE","README.md"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"extend-shallow":"^2.0.1","isobject":"^2.1.0","js-yaml-lite":"^0.1.1","moment":"^2.14.1"},"devDependencies":{"gulp-format-md":"^0.1.9","mocha":"^2.5.3"},"keywords":["changelog","stringify"],"verb":{"related":{"list":["helper-changelog"]},"toc":false,"layout":"common-minimal","tasks":["readme"],"plugins":["gulp-format-md"],"lint":{"reflinks":true},"reflinks":["verb","verb-generate-readme"]},"gitHead":"9550f582920cc7277186286d0282bb523a3784e7","_id":"stringify-changelog@0.2.1","_shasum":"47ca7a51e0d311432e306d327b71299d43e44d5b","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.3.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"47ca7a51e0d311432e306d327b71299d43e44d5b","size":4143,"noattachment":false,"key":"/stringify-changelog/-/stringify-changelog-0.2.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/stringify-changelog/download/stringify-changelog-0.2.1.tgz"},"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/stringify-changelog-0.2.1.tgz_1469095012675_0.8925776861142367"},"directories":{},"publish_time":1469095014658,"_cnpm_publish_time":1469095014658,"_hasShrinkwrap":false},"0.2.0":{"name":"stringify-changelog","description":"Generate a markdown-formatted changelog from an object, array or yaml file.","version":"0.2.0","homepage":"https://github.com/jonschlinkert/stringify-changelog","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/stringify-changelog.git"},"bugs":{"url":"https://github.com/jonschlinkert/stringify-changelog/issues"},"license":"MIT","files":["index.js","LICENSE","README.md"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"extend-shallow":"^2.0.1","isobject":"^2.1.0","js-yaml-lite":"^0.1.1","moment":"^2.14.1"},"devDependencies":{"gulp-format-md":"^0.1.9","mocha":"^2.5.3"},"keywords":["changelog","stringify"],"verb":{"related":{"list":["helper-changelog"]},"toc":false,"layout":"common-minimal","tasks":["readme"],"plugins":["gulp-format-md"],"lint":{"reflinks":true},"reflinks":["verb","verb-generate-readme"]},"gitHead":"425f0f5115f7fed27383f9e34840204124700342","_id":"stringify-changelog@0.2.0","_shasum":"ca6f3bfee0d201474198d20acc366737721d60bf","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.3.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"ca6f3bfee0d201474198d20acc366737721d60bf","size":4003,"noattachment":false,"key":"/stringify-changelog/-/stringify-changelog-0.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/stringify-changelog/download/stringify-changelog-0.2.0.tgz"},"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/stringify-changelog-0.2.0.tgz_1469092735990_0.7846627705730498"},"directories":{},"publish_time":1469092737636,"_cnpm_publish_time":1469092737636,"_hasShrinkwrap":false},"0.1.6":{"name":"stringify-changelog","description":"Generate a markdown-formatted changelog from an object, array or yaml file.","version":"0.1.6","homepage":"https://github.com/jonschlinkert/stringify-changelog","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/stringify-changelog.git"},"bugs":{"url":"https://github.com/jonschlinkert/stringify-changelog/issues"},"license":"MIT","files":["index.js","LICENSE","README.md"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"columnify":"^1.5.4","js-yaml-lite":"^0.1.1","mixin-deep":"^1.1.3","moment":"^2.14.1"},"devDependencies":{"gulp-format-md":"^0.1.9","mocha":"*","should":"*"},"keywords":["changelog","stringify"],"verb":{"related":{"list":["helper-changelog"]},"toc":false,"layout":"common-minimal","tasks":["readme"],"plugins":["gulp-format-md"],"lint":{"reflinks":true},"reflinks":["verb","verb-generate-readme"]},"gitHead":"21bd440c3f05e2ac5d89b709739f7436cddbb9ec","_id":"stringify-changelog@0.1.6","_shasum":"cbd6dceebeb7c7e56b21c1d9aa7e22ee1d9a7ad1","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.3.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"cbd6dceebeb7c7e56b21c1d9aa7e22ee1d9a7ad1","size":3122,"noattachment":false,"key":"/stringify-changelog/-/stringify-changelog-0.1.6.tgz","tarball":"http://registry.cnpm.dingdandao.com/stringify-changelog/download/stringify-changelog-0.1.6.tgz"},"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/stringify-changelog-0.1.6.tgz_1469083919779_0.7809286701958627"},"directories":{},"publish_time":1469083921738,"_cnpm_publish_time":1469083921738,"_hasShrinkwrap":false},"0.1.5":{"name":"stringify-changelog","description":"Generate a markdown-formatted changelog from an object, array or yaml file.","version":"0.1.5","homepage":"https://github.com/jonschlinkert/stringify-changelog","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/stringify-changelog.git"},"bugs":{"url":"https://github.com/jonschlinkert/stringify-changelog/issues"},"license":"MIT","files":["index.js","LICENSE","README.md"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"columnify":"^1.5.4","js-yaml-lite":"^0.1.1","mixin-deep":"^1.1.3","moment":"^2.14.1"},"devDependencies":{"gulp-format-md":"^0.1.9","mocha":"*","should":"*"},"keywords":["changelog","stringify"],"verb":{"related":{"list":["helper-changelog"]},"toc":false,"layout":"common-minimal","tasks":["readme"],"plugins":["gulp-format-md"],"lint":{"reflinks":true},"reflinks":["verb","verb-generate-readme"]},"gitHead":"a8126fe23f52e8c62d335d84391a8b366d14f175","_id":"stringify-changelog@0.1.5","_shasum":"1264804dabd8c260ef40d335d6737cab5993619a","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.3.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"1264804dabd8c260ef40d335d6737cab5993619a","size":3120,"noattachment":false,"key":"/stringify-changelog/-/stringify-changelog-0.1.5.tgz","tarball":"http://registry.cnpm.dingdandao.com/stringify-changelog/download/stringify-changelog-0.1.5.tgz"},"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/stringify-changelog-0.1.5.tgz_1469082799724_0.48071553953923285"},"directories":{},"publish_time":1469082801591,"_cnpm_publish_time":1469082801591,"_hasShrinkwrap":false},"0.1.4":{"name":"stringify-changelog","description":"Generate a markdown-formatted changelog from an object, array or yaml file.","version":"0.1.4","homepage":"https://github.com/jonschlinkert/stringify-changelog","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/stringify-changelog.git"},"bugs":{"url":"https://github.com/jonschlinkert/stringify-changelog/issues"},"license":"MIT","files":["index.js","LICENSE","README.md"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"columnify":"^1.5.4","js-yaml-lite":"^0.1.1","mixin-deep":"^1.1.3","moment":"^2.14.1"},"devDependencies":{"gulp-format-md":"^0.1.9","mocha":"*","should":"*"},"keywords":["changelog","stringify"],"verb":{"related":{"list":["helper-changelog"]},"toc":false,"layout":"common-minimal","tasks":["readme"],"plugins":["gulp-format-md"],"lint":{"reflinks":true},"reflinks":["verb","verb-generate-readme"]},"gitHead":"b15f89576923c55304955cea531bfb2ebcce7a94","_id":"stringify-changelog@0.1.4","_shasum":"541e61eda5306fda18bebec91915c7abf625be29","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.3.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"541e61eda5306fda18bebec91915c7abf625be29","size":3031,"noattachment":false,"key":"/stringify-changelog/-/stringify-changelog-0.1.4.tgz","tarball":"http://registry.cnpm.dingdandao.com/stringify-changelog/download/stringify-changelog-0.1.4.tgz"},"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/stringify-changelog-0.1.4.tgz_1469081884816_0.9545600707642734"},"directories":{},"publish_time":1469081886396,"_cnpm_publish_time":1469081886396,"_hasShrinkwrap":false},"0.1.3":{"name":"stringify-changelog","description":"Generate a markdown-formatted changelog from an object, array or yaml file.","version":"0.1.3","homepage":"https://github.com/jonschlinkert/stringify-changelog","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/stringify-changelog.git"},"bugs":{"url":"https://github.com/jonschlinkert/stringify-changelog/issues"},"license":"MIT","files":["index.js","LICENSE","README.md"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"columnify":"^1.5.4","js-yaml-lite":"^0.1.1","mixin-deep":"^1.1.3","moment":"^2.14.1"},"devDependencies":{"gulp-format-md":"^0.1.9","mocha":"*","should":"*"},"keywords":["changelog","stringify"],"verb":{"related":{"list":["helper-changelog"]},"toc":false,"layout":"nil","tasks":["readme"],"plugins":["gulp-format-md"],"lint":{"reflinks":true}},"gitHead":"511c4b86529883d9146807b6dcab88ccb86fc258","_id":"stringify-changelog@0.1.3","_shasum":"b44f98ef8d8089778378311460ffd847851fad52","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.3.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"b44f98ef8d8089778378311460ffd847851fad52","size":2979,"noattachment":false,"key":"/stringify-changelog/-/stringify-changelog-0.1.3.tgz","tarball":"http://registry.cnpm.dingdandao.com/stringify-changelog/download/stringify-changelog-0.1.3.tgz"},"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/stringify-changelog-0.1.3.tgz_1469081744162_0.048250024439767"},"directories":{},"publish_time":1469081745780,"_cnpm_publish_time":1469081745780,"_hasShrinkwrap":false},"0.1.1":{"name":"stringify-changelog","description":"Generate a markdown-formatted changelog from an object, array or yaml file.","version":"0.1.1","homepage":"https://github.com/jonschlinkert/stringify-changelog","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/stringify-changelog.git"},"bugs":{"url":"https://github.com/jonschlinkert/stringify-changelog/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"columnify":"^1.5.1","js-yaml":"^3.3.1","mixin-deep":"^1.1.1","moment":"^2.10.6"},"devDependencies":{"mocha":"*","should":"*"},"verb":{"related":{"list":["helper-changelog"]}},"keywords":["changelog"],"gitHead":"c0cfe1c1a126d70ea18e20a1314153295bcf4098","_id":"stringify-changelog@0.1.1","_shasum":"25142e9b2efe8f7c07f724b30061c6bac3a9cfc1","_from":".","_npmVersion":"2.10.1","_nodeVersion":"0.12.4","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"25142e9b2efe8f7c07f724b30061c6bac3a9cfc1","size":2805,"noattachment":false,"key":"/stringify-changelog/-/stringify-changelog-0.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/stringify-changelog/download/stringify-changelog-0.1.1.tgz"},"directories":{},"publish_time":1438406757820,"_cnpm_publish_time":1438406757820,"_hasShrinkwrap":false},"0.1.0":{"name":"stringify-changelog","description":"Generate a markdown-formatted changelog from an object or yaml file.","version":"0.1.0","homepage":"https://github.com/jonschlinkert/stringify-changelog","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/stringify-changelog.git"},"bugs":{"url":"https://github.com/jonschlinkert/stringify-changelog/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/stringify-changelog/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"columnify":"^1.4.1","js-yaml":"^3.2.7","mixin-deep":"^1.0.1","moment":"^2.9.0"},"devDependencies":{"mocha":"*","should":"*"},"gitHead":"8b7359533aa7ec9ec4216b7bac282d338041e373","_id":"stringify-changelog@0.1.0","_shasum":"b186137718e27e43ad038fb377bcc32d4d7e0f17","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"b186137718e27e43ad038fb377bcc32d4d7e0f17","size":2770,"noattachment":false,"key":"/stringify-changelog/-/stringify-changelog-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/stringify-changelog/download/stringify-changelog-0.1.0.tgz"},"directories":{},"publish_time":1426513725502,"_cnpm_publish_time":1426513725502,"_hasShrinkwrap":false}},"readme":"# stringify-changelog [![NPM version](https://img.shields.io/npm/v/stringify-changelog.svg?style=flat)](https://www.npmjs.com/package/stringify-changelog) [![NPM downloads](https://img.shields.io/npm/dm/stringify-changelog.svg?style=flat)](https://npmjs.org/package/stringify-changelog) [![Build Status](https://img.shields.io/travis/jonschlinkert/stringify-changelog.svg?style=flat)](https://travis-ci.org/jonschlinkert/stringify-changelog)\n\nGenerate a markdown-formatted changelog from an object, array, yaml or json file.\n\nConverts valid YAML, like this:\n\n```yaml\nv0.1.0:\n  date: \"2016-12-26\"\n  changed:\n    - Got stuck in another chimney.\n```\n\nInto this:\n\n```markdown\n### [v0.1.0] - 2016-12-26\n\n**changes**\n\n- Got stuck in another chimney.\n```\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save stringify-changelog\n```\n\n## Usage\n\n```js\nvar changelog = require('stringify-changelog');\nchangelog(value, options);\n```\n\n**Params**\n\n* `value` **{String|Object|Array}**: File path of YAML file to read, object or array of changes (see below)\n* `options` **{Object}**: the following options may be passed to modify output\n  - `format` **{Function}** Custom function for formatting each entry in the changelog\n  - `key` **{Function}** Prepend the following key/reference to your generated changelog, to guide users in making semantically labeled entries.\n\n**Example key**\n\n```\n## key\n\nChangelog entries are classified using the following labels from [keep-a-changelog][]:\n\n- `added`: for new features\n- `changed`: for changes in existing functionality\n- `deprecated`: for once-stable features removed in upcoming releases\n- `removed`: for deprecated features removed in this release\n- `fixed`: for any bug fixes\n\n[keep-a-changelog]: https://github.com/olivierlacan/keep-a-changelog\n```\n\n## Data format\n\nConventions from [keep-a-changelog][] are supported by default. When data is passed as an object or array (from a file or directly), changelog entries can be categorized using the following labels as property names:\n\n* `added` for new features.\n* `changed` for changes in existing functionality.\n* `deprecated` for once-stable features removed in upcoming releases.\n* `removed` for deprecated features removed in this release.\n* `fixed` for any bug fixes.\n* `security` to invite users to upgrade in case of vulnerabilities.\n\n### Examples\n\nData can either be formatted as an array or an object.\n\n**Object**\n\nJSON\n\n```js\n{ 'v0.1.0':\n   { date: '2016-12-26',\n     changed: [ 'Got stuck in another chimney.' ] } }\n```\n\nYAML\n\n```yaml\nv0.1.0:\n  date: \"2016-12-26\"\n  changed:\n    - Got stuck in another chimney.\n```\n\n**Array**\n\nJSON\n\n```js\n[ { date: '2016-12-26',\n    version: 'v0.1.0',\n    changed: [ 'Got stuck in another chimney.' ] } ]\n```\n\nYAML\n\n```yaml\n- version: v0.1.0\n  date: '2016-12-26'\n  changed:\n    - Got stuck in another chimney.\n```\n\n### Arbitrary entries\n\nIf you don't want to follow keep-a-changelog format, or you have an arbitrary entry that doesn't fit in one of the above categories, you can use the `description` property.\n\n**Array**\n\n```js\n[ { date: '2016-12-26',\n    version: 'v0.1.0',\n    description: [ 'Got stuck in another chimney.' ] } ]\n```\n\n**Object**\n\n```js\n{ 'v0.1.0':\n   { date: '2016-12-26',\n     description: [ 'Got stuck in another chimney.' ] } }\n```\n\n## About\n\n### Related projects\n\n[helper-changelog](https://www.npmjs.com/package/helper-changelog): Template helper for generating a markdown-formatted changelog from an object, array or yaml file. | [homepage](https://github.com/jonschlinkert/helper-changelog \"Template helper for generating a markdown-formatted changelog from an object, array or yaml file.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/jonschlinkert/stringify-changelog/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on July 21, 2016._","_attachments":{},"homepage":"https://github.com/jonschlinkert/stringify-changelog","bugs":{"url":"https://github.com/jonschlinkert/stringify-changelog/issues"},"license":"MIT"}