Giter VIP home page Giter VIP logo

bacon's Introduction

bacon

Latest Version Chat on Miaou

bacon is a background rust code checker.

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

screenshot

Documentation

The bacon website is a complete guide.

Below is a short overview.

check the current project

bacon

check another project

bacon --path ../broot

or

bacon ../broot

check all targets (tests, examples, benches, etc)

bacon --job check-all

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

bacon check-all

run clippy instead of cargo check

bacon clippy

or, if you want it to run against all targets (tests, examples, benches etc):

bacon clippy-all

run tests

bacon test

bacon test

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"]

or

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

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

and run

bacon check-win

or

bacon check-examples

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

Licences

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

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

bacon's People

Contributors

canop avatar rukai avatar nolanderc avatar jyn514 avatar jdomantas avatar stargateur avatar cgmossa avatar safarimonkey avatar cormacrelf avatar dicej avatar poignardazur avatar unclescientist avatar petervaro avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.