mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2025-02-06 11:34:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

contributing: recommend bacon over cargo-watch
Some checks are pending
binaries / Build binary artifacts (push) Waiting to run
Details
website / prerelease-docs-build-deploy (ubuntu-24.04) (push) Waiting to run
Details
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run
Details

Browse source 
As of [1], `cargo-watch` is on minimal development and officially
recommends `bacon` as a successor.

[1]: 9f27bc1c96,
This commit is contained in:
Bryce Berger 2025-01-08 20:40:21 -05:00
parent cba1966a77
commit 84e619cae6
2 changed files with 7 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/contributing.md
View file

@ -134,15 +134,13 @@ One-time setup:
rustup toolchain add nightly # wanted for 'rustfmt' rustup toolchain add nightly # wanted for 'rustfmt'
rustup toolchain add 1.76 # also specified in Cargo.toml rustup toolchain add 1.76 # also specified in Cargo.toml
cargo install cargo-insta cargo install --locked bacon
cargo install cargo-watch cargo install --locked cargo-insta
cargo install cargo-nextest cargo install --locked cargo-nextest
During development (adapt according to your preference): During development (adapt according to your preference):
cargo watch --ignore '.jj/**' -s \ bacon clippy-all
'cargo clippy --workspace --all-targets \
&& cargo +1.76 check --workspace --all-targets'
cargo +nightly fmt # Occasionally cargo +nightly fmt # Occasionally
cargo nextest run --workspace # Occasionally cargo nextest run --workspace # Occasionally
cargo insta test --workspace --test-runner nextest # Occasionally cargo insta test --workspace --test-runner nextest # Occasionally
@ -178,9 +176,8 @@ These are listed roughly in order of decreasing importance.
4. Your code needs to pass `cargo clippy`. You can also 4. Your code needs to pass `cargo clippy`. You can also
use `cargo +nightly clippy` if you wish to see more warnings. use `cargo +nightly clippy` if you wish to see more warnings.
5. You may also want to install and use `cargo-watch`. In this case, you should 5. You may also want to install and use [`bacon`](https://dystroy.org/bacon/),
exclude `.jj`. directory from the filesystem watcher, as it gets updated on to automatically build, check, and / or run tests.
every `jj log`.
6. To run tests more quickly, use `cargo nextest run --workspace`. To 6. To run tests more quickly, use `cargo nextest run --workspace`. To
use `nextest` with `insta`, use `cargo insta test --workspace use `nextest` with `insta`, use `cargo insta test --workspace

2
flake.nix
View file

@ -178,10 +178,10 @@
pkg-config pkg-config
# Additional tools recommended by contributing.md # Additional tools recommended by contributing.md
bacon
cargo-deny cargo-deny
cargo-insta cargo-insta
cargo-nextest cargo-nextest
cargo-watch
# Miscellaneous tools # Miscellaneous tools
watchman watchman