dev-templates/README.md

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 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
Clojure	clojure
C#	csharp
Cue	cue
Dhall	dhall
Elixir	elixir
Elm	elm
Empty (change at will)	empty
Gleam	gleam
Go	go
Hashicorp tools	hashi
Haxe	haxe
Java	java
[Jupyter]	jupyter
Kotlin	kotlin
LaTeX	latex
Nickel	nickel
Nim	nim
Nix	nix
Node.js	node
OCaml	ocaml
Open Policy Agent	opa
PHP	php
Protobuf	protobuf
Pulumi	pulumi
Purescript	purescript
Ruby	ruby
Rust	rust
RustPython	rustpython
Scala	scala
[Shell]	shell
Vlang	vlang
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.

clojure

• Clojure 1.11.1.1347
• Boot 2.8.3
• Leiningen 2.10.0

csharp

• dotnet sdk 7 (7.0.305)
• omnisharp-roslyn
• Mono 6.12.0.182
• msbuild 16.10.1

cue

• Cue 0.5.0

dhall

• Dhall 1.41.2
• dhall-bash
• dhall-docs
• dhall-json
• dhall-lsp-server
• dhall-nix
• dhall-nixpkgs
• dhall-openapi
• dhall-toml
• dhall-yaml

elixir

• Elixir 1.14.5, including mix and IEx
• gigalixir (Linux only)

elm

• Elm 0.19.1
• elm2nix

Empty

A dev template that's fully customizable.

gleam

• Gleam 0.30.0

go

• Go 1.20.5
• Standard Go tools (goimports, godoc, and others)
• golangci-lint

hashi

• Packer 1.8.6
• Terraform 1.5.2
• Nomad 1.4.6
• Vault 1.13.3
• nomad-autoscaler 0.3.6-dev
• nomad-pack 0.0.1-techpreview.3
• levant 0.3.2-dev
• damon
• Terragrunt 0.45.13
• tflint 0.46.1

haskell

• GHC 9.2.8
• cabal 3.10.1.0

haxe

• Haxe 4.2.5

java

• Java 20.0.1+9
• Maven 3.9.2
• Gradle 9.0.1
• jdtls 1.31.0

kotlin

• Kotlin 1.9.0
• Gradle 8.0.1

latex

• texlive
• tectonic
• texlab

nickel

• Nickel 0.2.0

nim

• Nim 1.6.14
• nimble 0.14.2

nix

• Cachix 1.6
• dhall-to-nix 1.1.25
• lorri 1.6.0
• niv 0.2.22
• nixfmt 0.5.0
• statix 0.5.6
• vulnix

node

• Node.js 18.16.1
• npm 9.5.1
• pnpm 8.6.6
• Yarn 1.22.19
• node2nix 1.11.1

ocaml

• OCaml 4.14.1
• Dune 3.9.1
• odoc 2.2.0
• ocamlformat 0.25.1

opa

• Open Policy Agent 0.54.0
• Conftest 0.44.0

php

• PHP 8.2.8
• Composer 2.5.8

protobuf

• The Buf CLI 1.23.1
• protoc 3.21.12

pulumi

• Pulumi 3.72.1
• Python 3.11.4
• Go 1.20.5
• Node.js 18.16.1
• dotnet sdk 6
• Java 19.0.1 and Maven 3.9.2
• jq 1.6

purescript

• Purescript (purs) 0.15.9
• Spago 0.21.0
• purescript-language-server 0.17.1
• purs-tidy 0.10.0

python

• Python 3.11.4
• pip 23.0.1

ruby

• Ruby 3.2.2, plus the standard Ruby tools (bundle, gem, etc.)

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.70.0 if neither is present

• rust-analyzer 2023-07-10

• cargo-audit 0.17.0

• cargo-deny 0.12.1

scala

• Scala 2.13.11 (Java 19.0.1)
• sbt 1.9.2

shell

• shellcheck 0.9.0

Vlang

• Vlang 0.4.4

zig

• Zig 0.10.1

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 to all the templates.