1
1
Fork 0
mirror of https://github.com/the-nix-way/dev-templates synced 2024-05-07 22:16:08 +02:00
Dev environments for numerous languages based on Nix flakes
Go to file
Luc Perkins 801caa1fcf
Add dvt script to flake outputs
2022-10-21 11:12:21 +02:00
.github Add FUNDING.yml 2022-07-29 18:29:57 +02:00
clojure Add rust-toolchain template 2022-10-20 16:14:56 +02:00
cue Add rust-toolchain template 2022-10-20 16:14:56 +02:00
dhall Add rust-toolchain template 2022-10-20 16:14:56 +02:00
elixir Add rust-toolchain template 2022-10-20 16:14:56 +02:00
elm Add rust-toolchain template 2022-10-20 16:14:56 +02:00
gleam Add rust-toolchain template 2022-10-20 16:14:56 +02:00
go Add rust-toolchain template 2022-10-20 16:14:56 +02:00
hashi Add rust-toolchain template 2022-10-20 16:14:56 +02:00
haskell Add rust-toolchain template 2022-10-20 16:14:56 +02:00
java Add rust-toolchain template 2022-10-20 16:14:56 +02:00
kotlin Add rust-toolchain template 2022-10-20 16:14:56 +02:00
nickel Add rust-toolchain template 2022-10-20 16:14:56 +02:00
nim Add rust-toolchain template 2022-10-20 16:14:56 +02:00
nix Add rust-toolchain template 2022-10-20 16:14:56 +02:00
node Add rust-toolchain template 2022-10-20 16:14:56 +02:00
ocaml Add rust-toolchain template 2022-10-20 16:14:56 +02:00
opa Add rust-toolchain template 2022-10-20 16:14:56 +02:00
protobuf Add rust-toolchain template 2022-10-20 16:14:56 +02:00
python Add rust-toolchain template 2022-10-20 16:14:56 +02:00
ruby Add rust-toolchain template 2022-10-20 16:14:56 +02:00
rust Add rust-toolchain template 2022-10-20 16:14:56 +02:00
rust-toolchain Add rust-toolchain template 2022-10-20 16:14:56 +02:00
scala Add rust-toolchain template 2022-10-20 16:14:56 +02:00
zig Add rust-toolchain template 2022-10-20 16:14:56 +02:00
.editorconfig Add editorconfig file 2022-07-12 02:01:42 +02:00
.envrc Add helper scripts via Nix 2022-07-29 00:42:22 +02:00
.gitignore Add dvt script to flake outputs 2022-10-21 11:12:21 +02:00
README.md Add tflint to hashi template 2022-08-23 15:42:54 +03:00
flake.lock Update root flake 2022-08-13 18:32:50 +03:00
flake.nix Add dvt script to flake outputs 2022-10-21 11:12:21 +02:00

Nix flake templates for easy dev environments

built with nix

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
Clojure clojure
Cue cue
Dhall dhall
Elixir elixir
Elm elm
Gleam gleam
Go go
Hashicorp tools hashi
Java java
Kotlin kotlin
Nickel nickel
Nim nim
Nix nix
Node.js node
OCaml ocaml
Open Policy Agent opa
Protobuf protobuf
Ruby ruby
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.

clojure

cue

dhall

elixir

elm

gleam

go

hashi

haskell

java

kotlin

nickel

nim

nix

node

ocaml

opa

protobuf

python

ruby

  • Ruby 3.1.2p20, 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.63.0 if neither is present
  • rust-analyzer 2022-08-01

  • cargo-audit 0.17.0

  • cargo-deny 0.12.1

  • cross 0.2.4

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.