This project is intended to make that easier by providing a CLI tool to read a CHANGELOG.md file from any NPM repository package or any registry you'v

@readachangelog/cli - npm

submited by
Style Pass
2024-10-25 21:00:04

This project is intended to make that easier by providing a CLI tool to read a CHANGELOG.md file from any NPM repository package or any registry you've configured in your NPM config (e.g. .npmrc). Yep, it should work with private repositories.

This project was thrown together quickly. Expect issues. This is my first CLI utility I've ever built in nodejs and I chose to build it with khalidx/typescript-cli-starter to deal with the wiring up of the executable. It was lighter weight than typescript-template/cli.

There are no shortage of opinions on CHANGELOG.md format, including filename. This project requires CHANGELOG.md to be at the root of the package. A LOT of packages do not have this.

The CHANGELOG.md file is parsed using changelog-parser and matches are checked using semver.satisfies. Because of this you may not get certain changelogs in the reporting. For example, a version like 1.7.0-beta.2 will not get printed using the "outdated" command nor in some cases when using "view" with the "--version" flag.

You could consider the changelog package but it requires a public respository on GitHub which is only a portion of the packages I was concerned about when creating this project.

Leave a Comment