{"_id":"@bassist/changelog","_rev":"5-345149013ee8a7a4ae1e2a92099b609e","name":"@bassist/changelog","dist-tags":{"latest":"0.3.0","alpha":"0.3.0-alpha.0"},"versions":{"0.1.0":{"name":"@bassist/changelog","version":"0.1.0","description":"Simple CHANGELOG generator by @chengpeiquan , based on conventional-changelog-cli.","author":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"license":"MIT","homepage":"https://github.com/chengpeiquan/bassist/tree/main/packages/changelog","bin":{"changelog":"index.cjs"},"main":"./index.cjs","repository":{"type":"git","url":"git+https://github.com/chengpeiquan/bassist.git"},"keywords":["changelog","changelog generator","generate changelog","CHANGELOG.md"],"dependencies":{"@withtypes/minimist":"^0.1.1","conventional-changelog-cli":"^4.1.0"},"bugs":{"url":"https://github.com/chengpeiquan/bassist/issues"},"_id":"@bassist/changelog@0.1.0","_integrity":"sha512-DpyBnNq3bXzrVmsTQ8TINepngCSxx3IkHqZbkWjW7XiYePX+mm0j+mHTWM5HBG1IOFZxZ8vXno4BiSvUyYDoYA==","_resolved":"/private/var/folders/kj/856p9v8j7sndztf7z51cwm2h0000gn/T/23c89b7363ba89eb0be521c9dbfbde7c/bassist-changelog-0.1.0.tgz","_from":"file:bassist-changelog-0.1.0.tgz","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-DpyBnNq3bXzrVmsTQ8TINepngCSxx3IkHqZbkWjW7XiYePX+mm0j+mHTWM5HBG1IOFZxZ8vXno4BiSvUyYDoYA==","shasum":"a0b75506943984c3243cfa430b87e296c29e75d6","tarball":"https://registry.npmjs.org/@bassist/changelog/-/changelog-0.1.0.tgz","fileCount":4,"unpackedSize":5070,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCID/FPUAjk1vHIsIAo3/uU8j49C3TlkRLAuLxf7nt2oBjAiBzwIy3Dr5iJ9bFp4F3nVCE4kljYFq8DH4cJk8EOcRzQw=="}]},"_npmUser":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"directories":{},"maintainers":[{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/changelog_0.1.0_1707928852461_0.15560198343974307"},"_hasShrinkwrap":false},"0.1.1-alpha.0":{"name":"@bassist/changelog","version":"0.1.1-alpha.0","description":"Simple CHANGELOG generator by @chengpeiquan , based on conventional-changelog-cli.","author":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"license":"MIT","homepage":"https://github.com/chengpeiquan/bassist/tree/main/packages/changelog","bin":{"changelog":"dist/index.cjs"},"main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"}},"repository":{"type":"git","url":"git+https://github.com/chengpeiquan/bassist.git"},"keywords":["changelog","changelog generator","generate changelog","CHANGELOG.md"],"dependencies":{"@withtypes/minimist":"^0.1.1","conventional-changelog-cli":"^4.1.0"},"readme":"# @bassist/changelog\n\n<p>\n  <a href='https://www.npmjs.com/package/@bassist/changelog'>\n    <img src=\"https://img.shields.io/npm/v/@bassist/changelog?color=f43f5e&label=npm\" />\n  </a>\n  <a href=\"https://www.npmjs.com/package/@bassist/changelog\" target=\"__blank\">\n    <img src=\"https://img.shields.io/npm/dt/@bassist/changelog?color=f43f5e&label=downloads\" />\n  </a>\n  <a href=\"https://github.com/chengpeiquan/bassist/tree/main/packages/changelog\" target=\"__blank\">\n    <img src=\"https://img.shields.io/static/v1?label=&message=docs%20%26%20demos&color=f43f5e\" />\n  </a>\n  <a href=\"https://github.com/chengpeiquan/bassist\" target=\"__blank\">\n    <img alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/chengpeiquan/bassist?style=social\" />\n  </a>\n</p>\n\nSimple CHANGELOG generator by [@chengpeiquan](https://github.com/chengpeiquan) , based on [conventional-changelog-cli](https://www.npmjs.com/package/conventional-changelog-cli).\n\n## Usage\n\nThis is a CLI tool, so you can use it with npx in your project root path.\n\n```bash\nnpx @bassist/changelog\n```\n\nYou can also install it locally and run it through commands such as pnpm exec.\n\n```bash\npnpm add -D @bassist/changelog\n```\n\nIn your `package.json` :\n\n```json\n{\n  \"scripts\": {\n    \"gen:changelog\": \"pnpm exec changelog\"\n  }\n}\n```\n\n## Options\n\nOn the command line, options can be passed to the program, e.g. `--preset angular`.\n\n| Option | Default Value  | Description                                                                                                                                                                  |\n| :----: | :------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| preset |   `angular`    | Name of the preset you want to use. Must be one of the following: `angular`, `atom`, `codemirror`, `conventionalcommits`, `ember`, `eslint`, `express`, `jquery` or `jshint` |\n| infile | `CHANGELOG.md` | Read the CHANGELOG from this file, and outputting to the same file                                                                                                           |\n|  path  |    `./src`     | Generate a changelog scoped to a specific directory                                                                                                                          |\n\n## Release Notes\n\nPlease refer to [CHANGELOG](https://github.com/chengpeiquan/bassist/blob/main/packages/eslint/CHANGELOG.md) for details.\n\n## License\n\nMIT License © 2023-PRESENT [chengpeiquan](https://github.com/chengpeiquan)\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/chengpeiquan/bassist/issues"},"_id":"@bassist/changelog@0.1.1-alpha.0","_integrity":"sha512-3yCtfX2gNtAJlcJ6fnHKct6L1rWEZL7/59OJmYYO/kTGuZIuvvMtUSeyJIw21vUU0PBo6JTwJvrF7SEEnPhhCA==","_resolved":"/private/var/folders/kj/856p9v8j7sndztf7z51cwm2h0000gn/T/3b4ded5d7fcf73a98fe717140e648945/bassist-changelog-0.1.1-alpha.0.tgz","_from":"file:bassist-changelog-0.1.1-alpha.0.tgz","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-3yCtfX2gNtAJlcJ6fnHKct6L1rWEZL7/59OJmYYO/kTGuZIuvvMtUSeyJIw21vUU0PBo6JTwJvrF7SEEnPhhCA==","shasum":"267ecfa1837b4f61084dfc530ebbdfd2f7fadc06","tarball":"https://registry.npmjs.org/@bassist/changelog/-/changelog-0.1.1-alpha.0.tgz","fileCount":7,"unpackedSize":6596,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDakbIK+seGDomNxjJDQocCyPLmuBp3bFd0Rpvx9GbKxgIgUDyVlzB1GhpCusECcSPY8ANV8iYA2kep5ruArbl/GCc="}]},"_npmUser":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"directories":{},"maintainers":[{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/changelog_0.1.1-alpha.0_1707930862693_0.7317735608411791"},"_hasShrinkwrap":false},"0.1.1-alpha.1":{"name":"@bassist/changelog","version":"0.1.1-alpha.1","description":"Simple CHANGELOG generator by @chengpeiquan , based on conventional-changelog-cli.","author":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"license":"MIT","homepage":"https://github.com/chengpeiquan/bassist/tree/main/packages/changelog","bin":{"changelog":"dist/index.cjs"},"main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"}},"repository":{"type":"git","url":"git+https://github.com/chengpeiquan/bassist.git"},"keywords":["changelog","changelog generator","generate changelog","CHANGELOG.md"],"dependencies":{"@withtypes/minimist":"^0.1.1","conventional-changelog-cli":"^4.1.0"},"readme":"# @bassist/changelog\n\n<p>\n  <a href='https://www.npmjs.com/package/@bassist/changelog'>\n    <img src=\"https://img.shields.io/npm/v/@bassist/changelog?color=f43f5e&label=npm\" />\n  </a>\n  <a href=\"https://www.npmjs.com/package/@bassist/changelog\" target=\"__blank\">\n    <img src=\"https://img.shields.io/npm/dt/@bassist/changelog?color=f43f5e&label=downloads\" />\n  </a>\n  <a href=\"https://github.com/chengpeiquan/bassist/tree/main/packages/changelog\" target=\"__blank\">\n    <img src=\"https://img.shields.io/static/v1?label=&message=docs%20%26%20demos&color=f43f5e\" />\n  </a>\n  <a href=\"https://github.com/chengpeiquan/bassist\" target=\"__blank\">\n    <img alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/chengpeiquan/bassist?style=social\" />\n  </a>\n</p>\n\nSimple CHANGELOG generator by [@chengpeiquan](https://github.com/chengpeiquan) , based on [conventional-changelog-cli](https://www.npmjs.com/package/conventional-changelog-cli).\n\n## Usage\n\nThis is a CLI tool, so you can use it with npx in your project root path.\n\n```bash\nnpx @bassist/changelog\n```\n\nYou can also install it locally and run it through commands such as pnpm exec.\n\n```bash\npnpm add -D @bassist/changelog\n```\n\nIn your `package.json` :\n\n```json\n{\n  \"scripts\": {\n    \"gen:changelog\": \"pnpm exec changelog\"\n  }\n}\n```\n\n## Options\n\nOn the command line, options can be passed to the program, e.g. `--preset angular`.\n\n| Option | Default Value  | Description                                                                                                                                                                  |\n| :----: | :------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| preset |   `angular`    | Name of the preset you want to use. Must be one of the following: `angular`, `atom`, `codemirror`, `conventionalcommits`, `ember`, `eslint`, `express`, `jquery` or `jshint` |\n| infile | `CHANGELOG.md` | Read the CHANGELOG from this file, and outputting to the same file                                                                                                           |\n|  path  |    `./src`     | Generate a changelog scoped to a specific directory                                                                                                                          |\n\n## Release Notes\n\nPlease refer to [CHANGELOG](https://github.com/chengpeiquan/bassist/blob/main/packages/eslint/CHANGELOG.md) for details.\n\n## License\n\nMIT License © 2023-PRESENT [chengpeiquan](https://github.com/chengpeiquan)\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/chengpeiquan/bassist/issues"},"_id":"@bassist/changelog@0.1.1-alpha.1","_integrity":"sha512-qlYtQWqjHk8f84NGiZ1B03NeqgI3E/00Xv3mDRRfvQDCNyOlm7gqVlIkDvDB5mukEudu80a16tWNESq7wTesdg==","_resolved":"/private/var/folders/kj/856p9v8j7sndztf7z51cwm2h0000gn/T/d32d13aad47588538a4ebc312952ce05/bassist-changelog-0.1.1-alpha.1.tgz","_from":"file:bassist-changelog-0.1.1-alpha.1.tgz","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-qlYtQWqjHk8f84NGiZ1B03NeqgI3E/00Xv3mDRRfvQDCNyOlm7gqVlIkDvDB5mukEudu80a16tWNESq7wTesdg==","shasum":"3d2a57c5dbfc59a84c35f70d7e16041c7f7dcda1","tarball":"https://registry.npmjs.org/@bassist/changelog/-/changelog-0.1.1-alpha.1.tgz","fileCount":7,"unpackedSize":6614,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCG7b6bEtGZ11Xg/lXFZXJ3URdgxnLJ84jl3yorUkIezAIgK84+FwUIGt2bn8QMdcMnFz4awR4fxfC52JPpJbuQ2fg="}]},"_npmUser":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"directories":{},"maintainers":[{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/changelog_0.1.1-alpha.1_1707931319715_0.2627951316549677"},"_hasShrinkwrap":false},"0.2.0":{"name":"@bassist/changelog","version":"0.2.0","description":"Simple CHANGELOG generator by @chengpeiquan , based on conventional-changelog-cli.","author":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"license":"MIT","homepage":"https://github.com/chengpeiquan/bassist/tree/main/packages/changelog","bin":{"changelog":"dist/index.cjs"},"main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"}},"repository":{"type":"git","url":"git+https://github.com/chengpeiquan/bassist.git"},"keywords":["changelog","changelog generator","generate changelog","CHANGELOG.md"],"dependencies":{"@withtypes/minimist":"^0.1.1","conventional-changelog-cli":"^4.1.0"},"bugs":{"url":"https://github.com/chengpeiquan/bassist/issues"},"_id":"@bassist/changelog@0.2.0","_integrity":"sha512-N/0QX9zJNNWdSUffSsdRgDDALXqNZLAM1Vb8wWzuq0sMULZUfj1upRVABMUtSBLOQUW0Chzrc2v2oII6iP/JdQ==","_resolved":"/private/var/folders/kj/856p9v8j7sndztf7z51cwm2h0000gn/T/7e7fd504c0df3fd373f58cb1003efd08/bassist-changelog-0.2.0.tgz","_from":"file:bassist-changelog-0.2.0.tgz","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-N/0QX9zJNNWdSUffSsdRgDDALXqNZLAM1Vb8wWzuq0sMULZUfj1upRVABMUtSBLOQUW0Chzrc2v2oII6iP/JdQ==","shasum":"6593c9259ede87def8c5ed18ff8acc0ef7148c4a","tarball":"https://registry.npmjs.org/@bassist/changelog/-/changelog-0.2.0.tgz","fileCount":7,"unpackedSize":10559,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIG/gM82vWD1pp6w+Os4Slih4msoyBb/yk4FFYXLn4rkrAiB9sMTuGPQPTnpZRI0hy4CbYZsHuySw/4IlmZ+RaZATgQ=="}]},"_npmUser":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"directories":{},"maintainers":[{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/changelog_0.2.0_1707990795694_0.1619416316251856"},"_hasShrinkwrap":false},"0.3.0-alpha.0":{"name":"@bassist/changelog","version":"0.3.0-alpha.0","description":"Simple CHANGELOG generator by @chengpeiquan , based on conventional-changelog-cli.","author":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"license":"MIT","homepage":"https://github.com/chengpeiquan/bassist/tree/main/packages/changelog","bin":{"changelog":"dist/index.mjs"},"main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"}},"repository":{"type":"git","url":"git+https://github.com/chengpeiquan/bassist.git"},"keywords":["changelog","changelog generator","generate changelog","CHANGELOG.md"],"dependencies":{"@withtypes/minimist":"^0.1.1","conventional-changelog-cli":"^4.1.0"},"peerDependencies":{"conventional-changelog-cli":">=4.1.0"},"readme":"# @bassist/changelog\n\n<p>\n  <a href='https://www.npmjs.com/package/@bassist/changelog'>\n    <img src=\"https://img.shields.io/npm/v/@bassist/changelog?color=f43f5e&label=npm\" />\n  </a>\n  <a href=\"https://www.npmjs.com/package/@bassist/changelog\" target=\"__blank\">\n    <img src=\"https://img.shields.io/npm/dt/@bassist/changelog?color=f43f5e&label=downloads\" />\n  </a>\n  <a href=\"https://github.com/chengpeiquan/bassist/tree/main/packages/changelog\" target=\"__blank\">\n    <img src=\"https://img.shields.io/static/v1?label=&message=docs%20%26%20demos&color=f43f5e\" />\n  </a>\n  <a href=\"https://github.com/chengpeiquan/bassist\" target=\"__blank\">\n    <img alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/chengpeiquan/bassist?style=social\" />\n  </a>\n</p>\n\nSimple CHANGELOG generator by [@chengpeiquan](https://github.com/chengpeiquan) , based on [conventional-changelog-cli](https://www.npmjs.com/package/conventional-changelog-cli).\n\nIf you are tired of remembering long command names and command line configurations every time, you can use this package to simplify the operation.\n\n## Usage\n\nThis is a CLI tool, you can install it locally and run it through commands such as pnpm exec.\n\nInstall it:\n\n```bash\npnpm add -D @bassist/changelog conventional-changelog-cli\n```\n\nIn your `package.json` :\n\n```json\n{\n  \"scripts\": {\n    \"gen:changelog\": \"pnpm exec changelog\"\n  }\n}\n```\n\nRun on command line:\n\n```bash\npnpm gen:changelog\n```\n\nYou can see a CHANGELOG.md file in the project root directory, which will generate the software's change records based on your Git Logs.\n\n## Implementation Principle\n\nIn this package, the program will run the conventional-changelog CLI command to generate CHANGELOG, so `conventional-changelog-cli`, as the peerDependency of the package, also needs to be installed together.\n\n## Options\n\nFor most projects, the default settings are sufficient. If adjustments are sometimes needed, some options are provided to pass on.\n\nOn the command line, options can be passed to the program, e.g. `--preset angular` by option, or `-p angular` by short flag.\n\n|    Option     | Short Flag | Default Value  | Description                                                                                                                                                                  |\n| :-----------: | :--------: | :------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| lerna-package |     l      |                | Generate a changelog for a specific lerna package (:pkg-name@1.0.0)                                                                                                          |\n|    preset     |     p      |   `angular`    | Name of the preset you want to use. Must be one of the following: `angular`, `atom`, `codemirror`, `conventionalcommits`, `ember`, `eslint`, `express`, `jquery` or `jshint` |\n|    infile     |     i      | `CHANGELOG.md` | Read the CHANGELOG from this file, and outputting to the same file                                                                                                           |\n| release-count |     r      |      `1`       | How many releases to be generated from the latest, If `0` , the whole changelog will be regenerated and the outfile will be overwritten directory                            |\n|  commit-path  |            |    `./src`     | Generate a changelog scoped to a specific directory                                                                                                                          |\n\nBtw: The paths are all based on `process.cwd()` , which is usually run from the root directory of the package (the directory where `package.json` is located).\n\nIf there are any running problems, please provide a reproducible example in the [issue](https://github.com/chengpeiquan/bassist/issues), or use [conventional-changelog-cli](https://www.npmjs.com/package/conventional-changelog-cli) directly (need to configure it yourself)\n\n## Release Notes\n\nPlease refer to [CHANGELOG](https://github.com/chengpeiquan/bassist/blob/main/packages/eslint/CHANGELOG.md) for details.\n\n## License\n\nMIT License © 2023-PRESENT [chengpeiquan](https://github.com/chengpeiquan)\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/chengpeiquan/bassist/issues"},"_id":"@bassist/changelog@0.3.0-alpha.0","_integrity":"sha512-Ko7nOzke/Vz43SfuUI0rHDH1a22g5/ALDpD2oonZpbsyAcfZ7cHUnHgclEnabUhhG8k9T2bKFHEUGSqmwDmtrw==","_resolved":"/private/var/folders/kj/856p9v8j7sndztf7z51cwm2h0000gn/T/7c58c777e4295d197df61ee7d42075be/bassist-changelog-0.3.0-alpha.0.tgz","_from":"file:bassist-changelog-0.3.0-alpha.0.tgz","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-Ko7nOzke/Vz43SfuUI0rHDH1a22g5/ALDpD2oonZpbsyAcfZ7cHUnHgclEnabUhhG8k9T2bKFHEUGSqmwDmtrw==","shasum":"25dfe204e4050abcbfc1138f60d2618fcb0168a1","tarball":"https://registry.npmjs.org/@bassist/changelog/-/changelog-0.3.0-alpha.0.tgz","fileCount":7,"unpackedSize":10565,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEhuhVnahotwQ/3tI3k5wS6qJt6O9Qmkh8hsPGEfkdu3AiEAvZnIzb1tmRVtaHdJaFKGnx9/8F5/habXxYyxBpa1I0c="}]},"_npmUser":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"directories":{},"maintainers":[{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/changelog_0.3.0-alpha.0_1707994641256_0.38237194022788157"},"_hasShrinkwrap":false},"0.3.0":{"name":"@bassist/changelog","version":"0.3.0","description":"Simple CHANGELOG generator by @chengpeiquan , based on conventional-changelog-cli.","author":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"license":"MIT","homepage":"https://github.com/chengpeiquan/bassist/tree/main/packages/changelog","bin":{"changelog":"dist/index.mjs"},"main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"}},"repository":{"type":"git","url":"git+https://github.com/chengpeiquan/bassist.git"},"keywords":["changelog","changelog generator","generate changelog","CHANGELOG.md"],"dependencies":{"@withtypes/minimist":"^0.1.1","conventional-changelog-cli":"^4.1.0"},"peerDependencies":{"conventional-changelog-cli":">=4.1.0"},"bugs":{"url":"https://github.com/chengpeiquan/bassist/issues"},"_id":"@bassist/changelog@0.3.0","_integrity":"sha512-xSdiM95gDD+CvkzdKsliwHYXqdWY2DkfCR/CQBgIKwazkKHqayTgjPbie9gRrFPWBUVC7H5sgUBT9iLOSxxIBw==","_resolved":"/private/var/folders/kj/856p9v8j7sndztf7z51cwm2h0000gn/T/99a1238cfcc3abae3f8d29bee2dd789a/bassist-changelog-0.3.0.tgz","_from":"file:bassist-changelog-0.3.0.tgz","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-xSdiM95gDD+CvkzdKsliwHYXqdWY2DkfCR/CQBgIKwazkKHqayTgjPbie9gRrFPWBUVC7H5sgUBT9iLOSxxIBw==","shasum":"3b1f58fec5687fb27193f8325f3240a17260778d","tarball":"https://registry.npmjs.org/@bassist/changelog/-/changelog-0.3.0.tgz","fileCount":7,"unpackedSize":10525,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBtL5ZEFBpUSG5y8hubtah2/EuUY811bRsUZZMih0AC5AiBuVup/msCNqFBc3niGz1iiGPrVETRQ+77P/N3GLYQceA=="}]},"_npmUser":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"directories":{},"maintainers":[{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/changelog_0.3.0_1707994815950_0.25273450592304436"},"_hasShrinkwrap":false}},"time":{"created":"2024-02-14T16:40:52.363Z","0.1.0":"2024-02-14T16:40:52.642Z","modified":"2024-02-15T11:00:16.933Z","0.1.1-alpha.0":"2024-02-14T17:14:22.968Z","0.1.1-alpha.1":"2024-02-14T17:21:59.932Z","0.2.0":"2024-02-15T09:53:15.858Z","0.3.0-alpha.0":"2024-02-15T10:57:21.379Z","0.3.0":"2024-02-15T11:00:16.099Z"},"maintainers":[{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"}],"description":"Simple CHANGELOG generator by @chengpeiquan , based on conventional-changelog-cli.","homepage":"https://github.com/chengpeiquan/bassist/tree/main/packages/changelog","keywords":["changelog","changelog generator","generate changelog","CHANGELOG.md"],"repository":{"type":"git","url":"git+https://github.com/chengpeiquan/bassist.git"},"author":{"name":"chengpeiquan","email":"chengpeiquan@chengpeiquan.com"},"bugs":{"url":"https://github.com/chengpeiquan/bassist/issues"},"license":"MIT","readme":"# @bassist/changelog\n\n<p>\n  <a href='https://www.npmjs.com/package/@bassist/changelog'>\n    <img src=\"https://img.shields.io/npm/v/@bassist/changelog?color=f43f5e&label=npm\" />\n  </a>\n  <a href=\"https://www.npmjs.com/package/@bassist/changelog\" target=\"__blank\">\n    <img src=\"https://img.shields.io/npm/dt/@bassist/changelog?color=f43f5e&label=downloads\" />\n  </a>\n  <a href=\"https://github.com/chengpeiquan/bassist/tree/main/packages/changelog\" target=\"__blank\">\n    <img src=\"https://img.shields.io/static/v1?label=&message=docs%20%26%20demos&color=f43f5e\" />\n  </a>\n  <a href=\"https://github.com/chengpeiquan/bassist\" target=\"__blank\">\n    <img alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/chengpeiquan/bassist?style=social\" />\n  </a>\n</p>\n\nSimple CHANGELOG generator by [@chengpeiquan](https://github.com/chengpeiquan) , based on [conventional-changelog-cli](https://www.npmjs.com/package/conventional-changelog-cli).\n\nIf you are tired of remembering long command names and command line configurations every time, you can use this package to simplify the operation.\n\n## Usage\n\nThis is a CLI tool, you can install it locally and run it through commands such as pnpm exec.\n\nInstall it:\n\n```bash\npnpm add -D @bassist/changelog conventional-changelog-cli\n```\n\nIn your `package.json` :\n\n```json\n{\n  \"scripts\": {\n    \"gen:changelog\": \"pnpm exec changelog\"\n  }\n}\n```\n\nRun on command line:\n\n```bash\npnpm gen:changelog\n```\n\nYou can see a CHANGELOG.md file in the project root directory, which will generate the software's change records based on your Git Logs.\n\n## Implementation Principle\n\nIn this package, the program will run the conventional-changelog CLI command to generate CHANGELOG, so `conventional-changelog-cli`, as the peerDependency of the package, also needs to be installed together.\n\n## Options\n\nFor most projects, the default settings are sufficient. If adjustments are sometimes needed, some options are provided to pass on.\n\nOn the command line, options can be passed to the program, e.g. `--preset angular` by option, or `-p angular` by short flag.\n\n|    Option     | Short Flag | Default Value  | Description                                                                                                                                                                  |\n| :-----------: | :--------: | :------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| lerna-package |     l      |                | Generate a changelog for a specific lerna package (:pkg-name@1.0.0)                                                                                                          |\n|    preset     |     p      |   `angular`    | Name of the preset you want to use. Must be one of the following: `angular`, `atom`, `codemirror`, `conventionalcommits`, `ember`, `eslint`, `express`, `jquery` or `jshint` |\n|    infile     |     i      | `CHANGELOG.md` | Read the CHANGELOG from this file, and outputting to the same file                                                                                                           |\n| release-count |     r      |      `1`       | How many releases to be generated from the latest, If `0` , the whole changelog will be regenerated and the outfile will be overwritten directory                            |\n|  commit-path  |            |    `./src`     | Generate a changelog scoped to a specific directory                                                                                                                          |\n\nBtw: The paths are all based on `process.cwd()` , which is usually run from the root directory of the package (the directory where `package.json` is located).\n\nIf there are any running problems, please provide a reproducible example in the [issue](https://github.com/chengpeiquan/bassist/issues), or use [conventional-changelog-cli](https://www.npmjs.com/package/conventional-changelog-cli) directly (need to configure it yourself)\n\n## Release Notes\n\nPlease refer to [CHANGELOG](https://github.com/chengpeiquan/bassist/blob/main/packages/eslint/CHANGELOG.md) for details.\n\n## License\n\nMIT License © 2023-PRESENT [chengpeiquan](https://github.com/chengpeiquan)\n","readmeFilename":"README.md"}