GitHub - cristianoliveira/funzzy: A lightweight blazingly fast file watcher.

5 min read Original article ↗

A lightweight blazingly fast file watcher inspired by antr and entr.

Configure auto-execution of different commands using semantic YAML and Unix shell style pattern match or stdin.

For a workflow as simple as:

find . -name '*.ts' | funzzy 'npx eslint {{relative_path}}'

Or more complex workflows like:

# .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.
# TIP2: List the tasks/steps from quicker to slower for better workflows
#
# Run: `fzz --fail-fast --non-block` (`fzz -nb`) to start this workflow (min: v1.4.0)

- name: run my tests
  run: make test
  change: "tests/**"
  ignore: "tests/integration/**"
  run_on_init: true

- name: Starwars ascii art
  run: telnet towel.blinkenlights.nl
  change:
    - "/tmp/starwars.txt"
    - ".watch.yaml"

# Command path templates for custom scripts
- name: run test & linter for a single file
  run:
   - "npm run lint -- {{relative_path}}",
   - "npm test -- $(echo '{{absolute_path}}' | sed -r s/.(j|t)sx?//)"
  change: ["src/**", "libs/**"]
  ignore: ["src/**/*.stories.*", "libs/**/*.log"]

- name: run ci checks @quick @ci
  run: | ## Watch with `fzz -t @ci`
   cat .github/workflows/on-push.yml \
    | yq '.jobs | .[] | .steps | .[] | .run | select(. != null)' \
    | xargs -I {} bash -c {}
  change: "src/**"
  run_on_init: true

- name: finally stage the changed files in git
  run:
    - git add {{relative_path}}
    - git commit
  change:
    - "src/**"
    - "tests/**"
  ignore: "**/*.log"

New in v1.6.0: Common rules format to reduce duplication!

# Share common watch patterns across tasks
on:
  change: ["src/**", "lib/**"]
  ignore: ["**/*.log"]

tasks:
  - name: build
    run: cargo build
  - name: test
    run: cargo test
    change: "tests/**"  # Override for specific task

** Nested groups for organizing tasks by domain!

# Frontend tasks
- on:
    change: ["src/frontend/**"]
  tasks:
    - name: frontend-build
      run: npm run build

# Backend tasks
- on:
    change: ["src/backend/**"]
  tasks:
    - name: backend-build
      run: cargo build

See more:

Enhance your workflows

Funzzy pairs well with these tools:

  • yq - A yaml querier similar to jq to extract commands from GitHub Actions!

  • nrr - For JS/TS projects, since Funzzy runs commands on change, a faster task runner makes a difference

Motivation

To create a lightweight watcher that allows me to set up personal local workflows with specific automated checks and steps, similar to GitHub Actions. Funzzy was built with Rust, which makes it blazingly fast and light.

Installing

OSX:

Latest release:

brew install cristianoliveira/tap/funzzy

Linux:

curl -s https://raw.githubusercontent.com/cristianoliveira/funzzy/master/linux-install.sh | sh

You can specify the versions:

curl -s https://raw.githubusercontent.com/cristianoliveira/funzzy/master/linux-install.sh | bash - 1.0.0

Nix

nix-env -iA nixpkgs.funzzy

Latest release:

nix profile install 'github:cristianoliveira/funzzy'
# or
nix profile install 'github:cristianoliveira/nixpkgs#funzzy'

Install nightly version:

nix profile install 'github:cristianoliveira/funzzy#nightly'

or, if you use shell.nix:

{ pkgs ? import <nixpkgs> {} }:
pkgs.mkShell {
  buildInputs = [
    pkgs.funzzy
  ];
};

With Cargo

*Make sure you have $HOME/.cargo/bin in your PATH export PATH=$HOME/.cargo/bin:$PATH

  • 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:

funzzy
# or use the short version
fzz

Options

Check all the options with fzz --help

Use a different config file:

Fail fast which bails the execution if any task fails. Useful for workflows that depend on all task to be successful. See its usage in our workflow

fzz --fail-fast # or fzz -b (bail)

Filtering tasks by target. (EXPERIMENTAL)

fzz -t "@quick"
# Assuming you have one or more tasks with `@quick` in the name, it will only load those tasks

Run with some arbitrary command and stdin

find . -name '*.rs' | fzz 'cargo build'

Templates for composing commands

find . -name '*.[jt]s' | fzz 'npx eslint {{filepath}}'

Run in "non-block" mode, which cancels the currently running task when there are new change events from files. It's super useful when a workflow contains long-running tasks. See more in long task test

fzz --non-block # or fzz -n

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 its 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 fzz -V | grep 'Triggered by' to understand what is triggering a task to be executed.

Automated tests

Running unit tests:

or simple make tests

Running integration tests:

Code Style

We use rustfmt to format the code. To format the code run:

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

Want to help?

  • Open pull requests
  • Create Issues
  • Report bugs
  • Suggest new features or enhancements

Any help is appreciated!

Pull Request should have unit tests

License

This project was made under MIT License.