bacon is a background rust code checker.

It's designed for minimal interaction so that you can jut let it running, side to your editor, and be notified of warnings and errors in your Rust code.

Installation

cargo install bacon

Usage

You launch bacon in a terminal you keep visible.

check the current project

bacon

check another project

bacon --path ../broot

or

bacon ../broot

run clippy instead of cargo check

bacon --job clippy

or

bacon clippy

define your own jobs

First create a bacon.toml file by running

bacon --init

This file already contains some standard jobs. Add your own, for example

[jobs.check-win] command = ["cargo", "check", "--target", "x86_64-pc-windows-gnu", "--color", "always"]

Don't forget the --color always part: bacon uses style information to recognize warnings and errors.

and run

bacon check-win

FAQ

What does it exactly do ?

It watches the content of your source directories and launches cargo check on changes.

Watching and computations are done on background threads to prevent any blocking.

The screen isn't cleaned until the compilation is finished to prevent flickering.

Errors are displayed before warnings because you usually want to fix them first.

Rendering is adapted to the dimensions of the terminal to ensure you get a proper usable report. And bacon manages rewrapping on resize.

Can I run several bacon in parallel ?

It's perfectly OK and can be useful for example to check several compilation targets.

Can I contribute ?

I'm busy rewriting bacon to incorporate new features, some visible in issues, some not.

I welcome issues, I welcome discussions in chat or on GitHub, I welcome diagnostics and prototypes, but right now I won't try to merge pull requests and will probably, at best, consider their content as technical hints and research.

What are the supported platforms ?

It works on all decent terminals on Linux, Max OSX and Windows.

Why "bacon" ?

• It's a background conpiler.
• It comes from France and, as you know, France is bacon.

Licences

Bacon is licenced under AGPL-3.0.

The logo is designed by Peter Varo and licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.