dev-templates/README.md
2022-07-31 18:11:52 +02:00

6 KiB

Nix flake templates for easy dev environments

To initialize (where ${ENV} is listed in the table below):

nix flake init --template github:the-nix-way/dev-templates#${ENV}

Here's an example (for the rust template):

# Initialize in the current project
nix flake init --template github:the-nix-way/dev-templates#rust

# Create a new project
nix flake new --template github:the-nix-way/dev-templates#rust ${NEW_PROJECT_DIRECTORY}

How to use the templates

Once your preferred template has been initialized, you can use the provided shell in two ways:

  1. If you have nix-direnv installed, you can initialize the environment by running direnv allow.
  2. If you don't have nix-direnv installed, you can run nix develop to open up the Nix-defined shell.

Available templates

Language/framework/tool Template
Dhall dhall
Elixir elixir
Gleam gleam
Go 1.17 go1_17
Go 1.18 go1_18
Hashicorp tools hashi
Java java
Kotlin kotlin
Nix nix
Node.js node
Protobuf protobuf
Rust rust
Scala scala
Zig zig

Template contents

The sections below list what each template includes. In all cases, you're free to add and remove packages as you see fit; the templates are just boilerplate.

dhall

elixir

gleam

go1.17

go1.18

hashi

java

kotlin

nix

node

protobuf

rust

  • Rust, including cargo, Clippy, and the other standard tools. The Rust version is determined as follows, in order:

    • From the rust-toolchain.toml file if present
    • From the rust-toolchain file if present
    • Version 1.6.2 if neither is present
  • [rust-analyzer] 2022-07-11

scala

zig

Code organization

All of the templates have only the root flake as a flake input. That root flake provides a common revision of Nixpkgs and flake-utils to all the templates.