{"_id":"@codeeshop/keep-a-changelog-whatsnew","_rev":"1-77c89b06f674659ba71c16b531126b49","name":"@codeeshop/keep-a-changelog-whatsnew","dist-tags":{"latest":"4.0.1"},"versions":{"4.0.0":{"name":"@codeeshop/keep-a-changelog-whatsnew","version":"4.0.0","private":false,"description":"Keep-a-changelog-whatsnew plugin for release-it","type":"module","exports":"./index.js","scripts":{"test":"bron test.js","release":"release-it"},"keywords":["release","release-it","release-it-plugin","keep-a-changelog-whatsnew","changelog","changes","unreleased"],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/codeeshop/keep-a-changelog-whatsnew.git"},"homepage":"https://github.com/codeeshop/keep-a-changelog-whatsnew#readme","bugs":{"url":"https://github.com/codeeshop/keep-a-changelog-whatsnew/issues"},"author":{"name":"Lars Kappert","email":"lars@webpro.nl","url":"https://webpro.nl"},"dependencies":{"detect-newline":"^4.0.0","string-template":"^1.0.0"},"devDependencies":{"bron":"^2.0.3","mock-fs":"^5.1.4","release-it":"^16.0.0","sinon":"^15.2.0"},"peerDependencies":{"release-it":"^16.0.0"},"engines":{"node":">=16"},"release-it":{"github":{"release":true,"tokenRef":"GITHUB_TOKEN_RELEASE_IT"},"hooks":{"before:init":"npm test"}},"gitHead":"4e59f4334bcf73d27e3b4f5e4526b6f5bcd7c0e2","_id":"@codeeshop/keep-a-changelog-whatsnew@4.0.0","_nodeVersion":"18.17.1","_npmVersion":"9.6.7","dist":{"integrity":"sha512-DaGYnXqS5NdPIrmg64SMnV2VNkIkzTicHJpggJKfG8JnRqnq8lKAQEyisKJgKsOa7gP7qIZmxnX1sSB5rXLhMw==","shasum":"d4ae1723da709d5e9ff0432a6e4281bf2a0d0804","tarball":"https://registry.npmjs.org/@codeeshop/keep-a-changelog-whatsnew/-/keep-a-changelog-whatsnew-4.0.0.tgz","fileCount":7,"unpackedSize":27872,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDdzB/3Nf5fCqyoFPCZi0Fy47XQiIUi6pEl+J64V5FCWAiAFqZL/Db6WgzVlNGBCFcWkvrOdJkOZjGvZCxGbcwnVag=="}]},"_npmUser":{"name":"codeeshop","email":"codeeshop2211@gmail.com"},"directories":{},"maintainers":[{"name":"codeeshop","email":"codeeshop2211@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/keep-a-changelog-whatsnew_4.0.0_1697116375680_0.9874787663950566"},"_hasShrinkwrap":false},"4.0.1":{"name":"@codeeshop/keep-a-changelog-whatsnew","version":"4.0.1","private":false,"description":"Keep-a-changelog-whatsnew plugin for release-it","type":"module","exports":"./index.js","scripts":{"test":"bron test.js","release":"release-it"},"keywords":["release","release-it","release-it-plugin","keep-a-changelog-whatsnew","changelog","changes","unreleased"],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/codeeshop/keep-a-changelog-whatsnew.git"},"homepage":"https://github.com/codeeshop/keep-a-changelog-whatsnew#readme","bugs":{"url":"https://github.com/codeeshop/keep-a-changelog-whatsnew/issues"},"author":{"name":"Lars Kappert","email":"lars@webpro.nl","url":"https://webpro.nl"},"dependencies":{"detect-newline":"^4.0.0","string-template":"^1.0.0"},"devDependencies":{"bron":"^2.0.3","mock-fs":"^5.1.4","release-it":"^16.0.0","sinon":"^15.2.0"},"peerDependencies":{"release-it":"^16.0.0"},"engines":{"node":">=16"},"release-it":{"github":{"release":true,"tokenRef":"GITHUB_TOKEN_RELEASE_IT"},"hooks":{"before:init":"npm test"}},"gitHead":"4e59f4334bcf73d27e3b4f5e4526b6f5bcd7c0e2","_id":"@codeeshop/keep-a-changelog-whatsnew@4.0.1","_nodeVersion":"18.17.1","_npmVersion":"9.6.7","dist":{"integrity":"sha512-/CYJhSyRdHjN2Gd+18KtO/0UFTRKHf2pH7/J0VViYhCqF1RiAqVwNilKVnamMkklFPDWeiR8NJPWOpHnttDO4g==","shasum":"769aec99dd647f4a78e6f4f2139174a28b1e4963","tarball":"https://registry.npmjs.org/@codeeshop/keep-a-changelog-whatsnew/-/keep-a-changelog-whatsnew-4.0.1.tgz","fileCount":6,"unpackedSize":28164,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIChX55+ufl+07Q08gCgmHg066i6MagjukMhD30NQnaRtAiAzBxoTlD0+LxiL5L9opQrVvD9/CZ6/0nOcaf0jcphlCQ=="}]},"_npmUser":{"name":"codeeshop","email":"codeeshop2211@gmail.com"},"directories":{},"maintainers":[{"name":"codeeshop","email":"codeeshop2211@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/keep-a-changelog-whatsnew_4.0.1_1697117108451_0.9908603115881152"},"_hasShrinkwrap":false}},"time":{"created":"2023-10-12T13:12:55.560Z","4.0.0":"2023-10-12T13:12:55.943Z","modified":"2023-10-12T13:25:08.824Z","4.0.1":"2023-10-12T13:25:08.656Z"},"maintainers":[{"name":"codeeshop","email":"codeeshop2211@gmail.com"}],"description":"Keep-a-changelog-whatsnew plugin for release-it","homepage":"https://github.com/codeeshop/keep-a-changelog-whatsnew#readme","keywords":["release","release-it","release-it-plugin","keep-a-changelog-whatsnew","changelog","changes","unreleased"],"repository":{"type":"git","url":"git+https://github.com/codeeshop/keep-a-changelog-whatsnew.git"},"author":{"name":"Lars Kappert","email":"lars@webpro.nl","url":"https://webpro.nl"},"bugs":{"url":"https://github.com/codeeshop/keep-a-changelog-whatsnew/issues"},"license":"MIT","readme":"# Keep-a-changelog plugin for release-it\n\nThis [release-it plugin](https://github.com/release-it/release-it/blob/master/docs/plugins.md) maintains your\nCHANGELOG.md file according to the [Keep A Changelog](https://keepachangelog.com/) standards.\n\nThe idea and initial implementation comes [from @eMarek](https://github.com/release-it/release-it/issues/662).\n\n```\nnpm install --save-dev @codeeshop/keep-a-changelog-whatsnew\n\nyarn add @codeeshop/keep-a-changelog-whatsnew\n```\n\nIn [release-it](https://github.com/release-it/release-it) config:\n\n```json\n\"plugins\": {\n  \"@codeeshop/keep-a-changelog-whatsnew\": {\n    \"filename\": \"CHANGELOG.md\"\n  }\n}\n```\n\n## Options\n\n| option            | default value    | description                                                                                                                                      |\n| ----------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |\n| whatsnew          | `'whatsnew/whatsnew-en-US'` | File with whatsnew.                                                                                                                            |\n| filename          | `'CHANGELOG.md'` | File with changelogs.                                                                                                                            |\n| strictLatest      | `true`           | Entry of latest version must be present in order to get correct changelog. Set this option to `false` if you expect latest version without logs. |\n| addUnreleased     | `false`          | It leaves \"Unreleased\" title row if set to `true`.                                                                                               |\n| keepUnreleased    | `false`          | It leaves \"Unreleased\" title row unchanged if set to `true`.                                                                                     |\n| addVersionUrl     | `false`          | Links the version to the according changeset. Uses GitHub-compatible URLs by default, see other options to configure the URL format.             |\n| versionUrlFormats | See below.       | Determines the version URL format when `addVersionUrl` is set to `true`. Uses GitHub-compatible URLs by default.                                 |\n| head              | `'HEAD'`         | The git revision the new version tag is compared to in the Unreleased URL.                                                                       |\n\n### versionUrlFormats\n\nThe URL formats used when `addVersionUrl` is set to `true`. Example configuration for a repository in Azure DevOps:\n\n```json\n\"plugins\": {\n  \"@release-it/keep-a-changelog\": {\n    \"filename\": \"CHANGELOG.md\",\n    \"head\": \"main\",\n    \"addVersionUrl\": true,\n    \"versionUrlFormats\": {\n      \"repositoryUrl\": \"https://dev.azure.com/...\",\n      \"unreleasedUrl\": \"{repositoryUrl}/branchCompare?baseVersion=GT{tagName}&targetVersion=GB{head}\",\n      \"versionUrl\": \"{repositoryUrl}/branchCompare?baseVersion=GT{previousTag}&targetVersion=GT{tagName}\",\n      \"firstVersionUrl\": \"{repositoryUrl}?version=GT{tagName}\"\n    }\n  }\n}\n```\n\n| option          | default value                                         | description                                                                                 |\n| --------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------- |\n| repositoryUrl   | `'https://{host}/{repository}'`                       | The format of the repository URL.                                                           |\n| unreleasedUrl   | `'{repositoryUrl}/compare/{tagName}...{head}'`        | The format of the `[unreleased]` section URL.                                               |\n| versionUrl      | `'{repositoryUrl}/compare/{previousTag}...{tagName}'` | The format of a release version URL.                                                        |\n| firstVersionUrl | `'{repositoryUrl}/releases/tag/{tagName}'`            | The format of the first release version URL, i.e. when no previous tags have been released. |\n","readmeFilename":"README.md"}