template-nix-rust/README.adoc
Daniel Lundin 07846537c8
All checks were successful
ci/woodpecker/push/ci Pipeline was successful
docs: Move README to asciidoc
2024-11-23 21:01:11 +01:00

1.8 KiB

Build Status

This is an opinionated template for rust projects using Nix.

Template features

  • CI template for Woodpecker.

  • Forgejo commit message templates.

  • Linting and formatting.

  • Nix-centered development environment.

  • Include language servers and all tooling in Nix dev shell.

Rust Opinions

Dev tools by default

  • direnv for automatic dev shell activation.

  • Bacon - automatic and minimal interaction code checker.

  • cargo-machete for removing unused dependencies.

  • hyperfine for simple benchmarking.

  • just for running things and discovery.

  • watchexec (and cargo-watch) for watching files and running commands.

Nix opinions

  • Crane for incremental artifact builds and nice set of checks.

  • Advisory-db for automatic checking of vulnerabilities of dependencies.

  • nix-filter allows filtering out files from the source input for a project.

  • treefmt supports automatic code formatting of all kinds of source code.