Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zdharma-continuum/zunit
A powerful testing framework for ZSH projects
https://github.com/zdharma-continuum/zunit
zinit zinit-plugin zsh zsh-plugin zsh-plugins zshell
Last synced: 6 days ago
JSON representation
A powerful testing framework for ZSH projects
- Host: GitHub
- URL: https://github.com/zdharma-continuum/zunit
- Owner: zdharma-continuum
- License: mit
- Fork: true (zunit-zsh/zunit)
- Created: 2022-02-07T00:35:04.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-20T10:41:39.000Z (11 months ago)
- Last Synced: 2025-01-20T02:06:48.358Z (8 days ago)
- Topics: zinit, zinit-plugin, zsh, zsh-plugin, zsh-plugins, zshell
- Language: Shell
- Homepage: https://zunit.xyz
- Size: 284 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
![ZUnit](https://zunit.xyz/img/logo.png)
[![GitHub release](https://img.shields.io/github/release/zdharma-continuum/zunit.svg)](https://github.com/zdharma-continuum/zunit/releases/latest)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/zdharma-continuum/zinit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)ZUnit is a powerful unit testing framework for ZSH
## Installation
> **WARNING**: Although the majority of ZUnit's functionality works as expected, it is in the early stages of
> development, and as such bugs are likely to be present. Please continue with caution, and
> [report any issues](https://github.com/zunit-zsh/zunit/issues/new) you may have.### [Zinit](https://github.com/zdharma-continuum/zinit)
```sh
zinit build for @zdharma-continuum/zunit
```### Manual
```zsh
git clone https://github.com/zdharma-continuum/zunit.git
cd zunit
./configure
make
make install
```## Writing Tests
### Test syntax
Tests in ZUnit have a simple syntax, which is inspired by the [BATS](https://github.com/sstephenson/bats) framework.
```zsh
#!/usr/bin/env zunit@test 'example test' {
# test logic
}
```The body of each test can contain any valid ZSH code. The zunit shebang `#!/usr/bin/env zunit` **MUST** appear at the
top of each test file, or ZUnit will not run it.## Documentation
For a full breakdown of ZUnit's syntax and functionality, check out the
[official documentation](https://zunit.xyz/docs/).## Contributing
All contributions are welcome, and encouraged. Please read our [contribution guidelines](contributing.md) and
[code of conduct](code-of-conduct.md) for more information.## License
ZUnit is licensed under The MIT License (MIT)
Copyright (c) 2016 - 2022 James Dinsdale (molovo.co)
Copyright (c) 2022 zdharma-continuum