Repository files navigation

bacon is a background code checker.

It's designed for minimal interaction so that you can just let it run, alongside your editor, and be notified of warnings, errors, or test failures in your Rust code.

Thebacon website is a complete guide.

Below is only a short overview.

cargo install --locked bacon

Run this command too if you want to update bacon. Configuration has always been retro-compatible so you won't lose anything.

Some features are disabled by default. You may enable them with

cargo install --features "clipboard sound"

bacon

That's how you'll usually launch bacon, because other jobs liketest,clippy,doc, your own ones, are just a key away: You'll hitc to see Clippy warnings,t for the tests,d to open the documentation, etc.

bacon --path ../broot

or

bacon ../broot

bacon --job check-all

When there's no ambiguity, you may omit the--job part:

bacon check-all

bacon clippy

This will run against all targets likecheck-all does.

bacon test

orbacon nextest if you're a nextest user.

When there's a failure, hitf to restrict the job to the failing test.Hitesc to get back to all tests.

First create abacon.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"]

or

[jobs.check-examples]command = ["cargo","check","--examples"]watch = ["examples"]# src is implicitly included

and run

bacon check-win

or

bacon check-examples

Thebacon.toml file may evolve with the features and settings of your project and should be added to source control.

Some bacon features can be disabled or enabled at compilation:

• "clipboard" - disabled by default : necessary for thecopy-unstyled-output internal
• "sound" - disabled by default : necessary for theplay-sound internal

Bacon is licenced underAGPL-3.0.You're free to use it to compile the Rust projects of your choice, even commercial.

The logo is designed byPeter Varo and licensed under aCreative Commons Attribution-ShareAlike 4.0 International License.