A GitHub App built with Probot that diffs yarn lockfile changes on pull requests and creates a simple visualization of the diffs.
Nugget is my pet cat 🐈 and I'd like to believe in the web development world, Nugget likes to play with yarn lockfiles.
Ever been annoyed at how a yarn.lock file can potentially have a large diff and produce PRs with the following visual:
and upon loading the diff
- your browser slows down
- you have to scroll forever
- it's pretty much impossible to verify all version changes if not any
A common case where such large diffs from lockfiles are generated are from Renovate's lockfile maintenance or from having to do a clean install for some reason. Regardless it is difficult to understand all the packages being added, removed, and package versions being modified.
Why couldn't there be a webhook that detects a yarn.lock change and parses the lockfile to generate a table visualization that summarizes the lockfile diff? And so I introduce Nugget!
Nugget is NOT meant to be a replacement for reviewing yarn lockfile changes. It is merely a simple visualization of the lockfile diff and a tool to be more confident of any lockfile changes.
After detecting and parsing a yarn.lock diff in your pull request, Nugget categorizes package changes into three groups:
- Packages Added
- What new package has been added?
- Packages Modified
- What version has been added/removed/updated to an existing package?
- If applicable, what existing versions are still installed?
- Packages Removed
- What package has been removed?
Here's an example comment that Nugget will post
If you have suggestions for how nugget could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
For more, check out the Contributing Guide.
ISC © 2019 Chris Lee [email protected]