list breaking changes in newer major versions of packages
How it works
Right now only packages hosted on GitHub are supported.
what-broke will get
the package info and repository URL from
npm, then try to fetch the GitHub
release for each relevant version tag. If no GitHub release is found it will
fall back to trying to parse the package's
GitHub releases are way more reliable for this purpose though, so please use
what-broke inevitably fails to find changelog entries for some packages/releases
because many maintainers are not very detail-oriented about it (and don't choose
to use excellent tools that would do the work for them, like
However, I've also seen cases where some versions were never published to npm
(for instance, at the time of writing,
superagent version 5.0.0 was never
published to npm, yet it does have a changelog entry).
only displays changelog entries for published versions.
GitHub heavily rate limits public API requests, but allows more throughput for
authenticated requests. If you set the
GH_TOKEN environment variable to a
personal access token,
what-broke will use it when requesting GitHub releases.
what-broke will also use the
NPM_TOKEN environment variable or try to get
the npm token from your
~/.npmrc, so that it can get information for private
packages you request.
npm i -g what-broke
what-broke <package> [--full] [<from verison> [<to version>]]
Will print out the changelog contents for all major and prerelease versions in
the given range. (If
--full is given, it will also include minor and patch
package is installed in the current working directory,
will default to the installed version.
(the CLI just uses this under the hood)