1
1
Fork 0
mirror of https://github.com/the-nix-way/dev-templates synced 2024-05-13 11:36:19 +02:00
Dev environments for numerous languages based on Nix flakes
Go to file
Luc Perkins 57a613b3d1
Merge pull request #35 from crc-sstubbs/task/rust-analyzer-vscode
task: allow rust analyzer to work with vscode
2024-01-18 13:15:05 -03:00
.github Minor change to workflow YAML 2023-08-22 11:13:18 -07:00
clojure Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
csharp Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
cue Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
dhall Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
elixir Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
elm Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
gleam Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
go Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
hashi Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
haskell Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
java Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
kotlin Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
latex Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
nickel Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
nim Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
nix Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
node Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
ocaml Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
opa Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
php Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
protobuf Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
pulumi Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
purescript fix purescript 2023-12-28 00:04:33 +03:00
python Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
ruby Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
rust Merge pull request #35 from crc-sstubbs/task/rust-analyzer-vscode 2024-01-18 13:15:05 -03:00
rust-toolchain fix rust inputs 2023-12-27 23:59:59 +03:00
scala Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
shell Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
zig Switch to FlakeHub URLs 2023-12-21 10:45:59 -08:00
.editorconfig Add editorconfig file 2022-07-12 02:01:42 +02:00
.envrc Update clojure and csharp 2023-07-13 15:15:22 -07:00
.gitignore Add dvt script to flake outputs 2022-10-21 11:12:21 +02:00
README.md Merge pull request #23 from the-nix-way/pulumi-template 2023-07-14 08:43:38 -07:00
flake.lock Remove flake-utils from root flake.nix 2023-07-13 17:26:57 -07:00
flake.nix Merge pull request #23 from the-nix-way/pulumi-template 2023-07-14 08:43:38 -07: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
C# csharp
Cue cue
Dhall dhall
Elixir elixir
Elm elm
Gleam gleam
Go go
Hashicorp tools hashi
Java java
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
Scala scala
[Shell] shell
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

csharp

cue

dhall

elixir

elm

gleam

go

hashi

haskell

java

kotlin

latex

nickel

nim

nix

node

ocaml

opa

php

protobuf

pulumi

purescript

python

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

shell

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.