https://github.com/srwiez/whatsdiff
CLI tool to see what has changed in your project's dependencies
https://github.com/srwiez/whatsdiff
cli cli-app composer tool
Last synced: 3 months ago
JSON representation
CLI tool to see what has changed in your project's dependencies
- Host: GitHub
- URL: https://github.com/srwiez/whatsdiff
- Owner: SRWieZ
- License: mit
- Created: 2024-09-08T14:23:28.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-03-31T16:54:12.000Z (3 months ago)
- Last Synced: 2025-04-06T04:48:23.391Z (3 months ago)
- Topics: cli, cli-app, composer, tool
- Language: PHP
- Homepage: https://srwiez.com/open-source
- Size: 625 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# whatsdiff
What's diff is a CLI tool to help you inspect what has changed in your dependencies after a `composer update` or `npm update`.
Main features are:
- Show what has been added, removed or updated in your dependencies
- Show how many releases have been made since your last update
- Support for composer.lock and package-lock.json (PHP & JS)
- [WIP] Show changelog of the dependencies
- [WIP] Compare two commits
## 🚀 Installation
Via [Composer](https://getcomposer.org/) global require command
```bash
composer global require srwiez/whatsdiff
```
By [downloading binaries](https://github.com/SRWieZ/whatsdiff/releases/latest) on the latest release, currently only these binaries are compiled on the CI:
- macOS x86_64
- macOS arm64
- linux x86_64
- linux arm64
- windows x64
## 📚 Usage
Go on your project root directory after a `composer update` and just ask:
```bash
whatsdiff
```
## 📋 Roadmap
Pull requests are welcome! Here are some ideas to get you started:
- [ ] Make a nice TUI (WIP on [#1](https://github.com/SRWieZ/whatsdiff/pull/1))
- [ ] Output format (json, markdown, no-ansi)
- [ ] Retrieve changelog with Github API
- [ ] Publish on NPM
- [ ] Analyse gradle dependencies (android)
- [ ] Analyse cocoapods dependencies (iOS)
- [ ] Analyse pip dependencies (python)
- [ ] Analyse gem dependencies (ruby)
- [ ] Analyse cargo dependencies (rust)
- [ ] Analyse go.mod dependencies (go)
- [ ] Publish on Homebrew
## 🔧 Contributing
This project follows PSR coding style. You can use `composer pint` to apply.
All tests are executed with pest. Use `composer pest`
It's recommended to execute `composer qa` before commiting (alias for executing Pint and Pest)
### Testing
This project use [Pest](https://pestphp.com/) for testing.
```bash
composer test
```
### Build from sources
This project use [box](https://github.com/box-project/box), [php-static-cli](https://github.com/crazywhalecc/static-php-cli) and [php-micro](https://github.com/dixyes/phpmicro).
A build script has been created to build the project. (tested only on macOS x86_64)
```bash
composer build
```
Then you can build the binary that you can retrieve in `build/bin/`
## 👥 Credits
**whatsdiff** was created by Eser DENIZ.
## 📝 License
**whatsdiff** PHP is licensed under the MIT License. See LICENSE for more information.