funzzy (fzz)
Yet another fancy watcher. (Inspired by antr / entr). See also funzzy.nvim
Configure auto-execution of different commands using semantic YAML and Unix shell style pattern match or stdin.
As simple as
|
Or complicated as
# .watch.yaml (or .watch.yml)
# list here all the events and the commands that it should execute
# TIP: include '.watch.yaml' in your .git/info/exclude to ignore it.
- name: run my tests
run: make test
change: "tests/**"
ignore: "tests/integration/**"
- name: Starwars
run: telnet towel.blinkenlights.nl
change: ".watch.yaml"
- name: say hello
run: echo "hello on init"
change: "./*.yaml"
run_on_init: true
# Command templates for custom scripts
- name: run test & linter for a single file
run:
change:
ignore:
Motivation
Create a lightweight watcher to run my tests every time something in my project change. So I won't forget to keep my tests passing. Funzzy was made with Rust which is why it consumes almost nothing to run.
Installing
- OSX:
- Linux:
|
- With Cargo
*Make sure you have $HOME/.cargo/bin
in your PATH
export $PATH:$HOME/.cargo/bin
From source
Make sure you have installed the following dependencies:
- Rust
- Cargo
Execute:
cargo install --git https://github.com/cristianoliveira/funzzy.git
Or, clone this repo and run:
Running
Initializing with boilerplate:
Change the config file .watch.yaml
as you want. Then run:
# or use the short version
Options
Use a different config file:
Filtering task by target (contais in task name):
Run with some arbitrary command and stdin
|
Templates for composing commands
|
Running in "non-block" mode which cancels the currently running task once something changes super useful if you need to run a long task and don't want to wait for it to finish after a change in the code. See: long task test
See more in examples or in the integration specs
Troubleshooting
Why the watcher is running the same task multiple times?
This might be due to different causes, the most common issue when using VIM is because of the default backup setting which causes changes to multiple files on save. See Why does Vim save files with a ~ extension?. For such cases either disable the backup or ignore them in your watch rules.
For other cases use the verbose funzzy -V
to understand what is triggering a task to be executed.
Automated tests
Running unit tests:
or simple make tests
Running integration tests:
make integration
Code Style
We use clippy for linting the funzzy's source code. Make sure you had validated it before committing.
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request
Pull Requests are really welcome! Others support also.
Pull Request should have unit tests
License
This project was made under MIT License.