Changelog-reminder is a CHANGELOG file parsing and logging tool. It will parse the changelog file with keep a changelog as the standard format.
After parsing the changelog file of your project, it will show what new features have been added since the last update and records the current changelog version as the basis for the next.
$ npm install changelog-reminder
Or install it to global:
$ npm install changelog-reminder -g
npm is a builtin CLI when you install Node.js - Installing Node.js with NVM
Start parsing and logging
Make sure you have a changelog file in your project. You can find the sample and standard format changelog file in keep a changelog.
Installed in global
Installed as a dependency in project
Add this starting instruction to NPM scripts, such as this
$ npm run start, the changelog-reminder will launch.
No changes found
If no changes found, changelog-reminder will show the status:
changelog-reminder [options]. Check all options by typing
$ changelog-reminder -h
Changelog-reminder will load
changelog-reminder.yaml as config file by default. Also you can use
changelog-reminder -c <file relative path> to specify a config file.
If no config file is existed in your project, the config data will use default arguments.
// changelog-reminder.jsconst path = ;moduleexports =confirm: trueshowIntro: truechangelog: "./test/CHANGELOG"logger: path;
changelog: Specify the changelog file. Default:
logger: Specify the logger file, it records which verison you are staying at. Default:
showIntrooption: changelog-reminder will display the CHANGELOG introduction each time. Default:
confirmoption: after displaying the changes, changelog-reminder will enquire your whether already know the changes. It makes sure developers exactly know what's new. Default: