This project is a simple changelog parser written in Node.js. The parser assumes that Semantic Versioning will be used and that the format roughly conforms to Keep a Changelog.
It will simply check if a specified changelog follows rules like:
- contains an 'Unreleased' section at the top of all releases
- uses only valid types of changes
- does not contain undefined references
- does not define references that aren't used
- has valid versioning (e.g. 1.1.0 can't be a later release than 1.2.0)
- ...
It will not check if the contents of the file comply with the Keep a Changelog format completely.
Pass the path to a changelog to validate it.
node index.js path/to/CHANGELOG.md
Use -v or --version to retrieve the current version (the one of the latest release).
node index.js -v path/to/CHANGELOG.md
Use -c or --changes to retrieve the content (as markdown) of the latest release.
node index.js -c path/to/CHANGELOG.md
Use --today to also make sure that the date of the latest release is the current date.
node index.js --today path/to/CHANGELOG.md
You may use npm link to install Chap to your PATH. You can then use:
chap -v path/to/CHANGELOG.md
You can also use Chap with Docker.
docker run --rm -v /path/to/CHANGELOG.md:/usr/src/app/CHANGELOG.md wesone/chap chap CHANGELOG.md