docs: add nix development instructions #8278
Conversation
thoughtpolice
left a comment
thoughtpolice
left a comment
There was a problem hiding this comment.
mostly looks good, minor nits
| If you use [direnv](https://direnv.net/) with | ||
| [nix-direnv](https://github.com/nix-community/nix-direnv), you can create | ||
| a `.envrc` file containing `use flake` to automatically activate the | ||
| development environment when entering the directory. | ||
There was a problem hiding this comment.
FWIW, if you want, you can replace/reword this bit with:
ln -vsf .envrc.recommended .envrc
Which will just do this for you.
(We should maybe rename it .envrc.nix.recommended or something too, but that's a separate topic.)
There was a problem hiding this comment.
Inside .envrc.recommended, we actually currently have a comment suggesting this command instead, so we should probably make them consistent (I'm not sure which way is better):
echo "source_env .envrc.recommended" >> .envrc| This gives you a shell with: | ||
| - A nightly Rust toolchain (including `rustfmt`, `rust-analyzer`, and | ||
| `rust-src`) |
There was a problem hiding this comment.
rust-src isn't relevant imo. can probably just replace this whole section with a single sentence:
Once inside the shell, you can run
cargo build,cargo testetc. as usual. Other tools likeuv,cargo-insta,nextestand more are installed, and so you should be able to follow any other recommendations in this guide as needed.
3 participants
Fixes #1435
Checklist
If applicable:
CHANGELOG.mdREADME.md,docs/,demos/)cli/src/config-schema.json)