https://github.com/hernancerm/zgold
Golden testing on stdout/stderr with Zsh
https://github.com/hernancerm/zgold
golden-testing testing zsh
Last synced: 4 months ago
JSON representation
Golden testing on stdout/stderr with Zsh
- Host: GitHub
- URL: https://github.com/hernancerm/zgold
- Owner: hernancerm
- License: mit
- Created: 2024-07-07T17:45:05.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-27T17:57:56.000Z (about 1 year ago)
- Last Synced: 2026-02-20T08:48:17.586Z (4 months ago)
- Topics: golden-testing, testing, zsh
- Language: Shell
- Homepage:
- Size: 156 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZGold
Zsh command line tool for golden tests on stdout/stderr.
## Features
- Declarative.
- Can be used to test software written in any language.
- View diffs of failed tests in [delta](https://github.com/dandavison/delta).
- Patch golden files.
## Installation
1. Add the [Homebrew](https://brew.sh/) tap:
```
brew tap hernancerm/formulas https://github.com/hernancerm/formulas
```
2. Install ZGold:
```
brew install zgold
```
## Usage
Once ZGold is installed:
- See the built-in help with `zgold --help`.
- For sample output, execute this in this repo: `zgold -b demo/*`.
## Development
[DEVELOP.md](./DEVELOP.md)
## Inspiration
ZGold's output format mirrors that of
[ZUnit](https://github.com/zunit-zsh/zunit).
## License
[MIT](./LICENSE)