Home

Awesome

zsh-test-runner (ztr) GitHub release (latest by date)

Straight-forward tests and coverage reports for zsh and —under zsh's emulation— csh, ksh, and sh

What it features: everything you need for testing zsh scripts.

What it does not feature: its own human language-like declarative test syntax.

There's no "describe", "expect", etc. Downside is the tests don't read like a story. Upside is —because the shell already has rich support for tests— there is nothing idiomatic to learn, there are no artificial limits on what can be tested, the cost to migrating to zsh-test-runner (or from it, if you must) is very low, and there is no risk that assertions were incorrectly implemented. Just write your [[ ]]s, (( ))s, even your tests and [ ]s.

Documentation

📖 See the guide at https://zsh-test-runner.olets.dev/

Examples

See the examples' README.

Changelog

See CHANGELOG.

Roadmap

See ROADMAP.

Contributing

Looking for the documentation site's source? See https://github.com/olets/zsh-test-runner-docs

Thanks for your interest. Contributions are welcome!

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Check the Issues to see if your topic has been discussed before or if it is being worked on. You may also want to check the roadmap (see above).

Please read CONTRIBUTING.md before opening a pull request.

To test ztr run zsh ./tests/ztr.ztr.zsh

License

<a href="https://www.github.com/olets/zsh-test-runner">zsh-test-runner</a> by <a href="https://www.github.com/olets">Henry Bley-Vroman</a> is licensed under a license which is the unmodified text of <a href="https://creativecommons.org/licenses/by-nc-sa/4.0">CC BY-NC-SA 4.0</a> and the unmodified text of a <a href="https://firstdonoharm.dev/build?modules=eco,extr,media,mil,sv,usta">Hippocratic License 3</a>. It is not affiliated with Creative Commons or the Organization for Ethical Source.

Human-readable summary of (and not a substitute for) the LICENSE file:

You are free to

Under the following terms