1
1
Fork 0
mirror of https://github.com/the-nix-way/dev-templates synced 2024-05-04 23:26:16 +02:00
Dev environments for numerous languages based on Nix flakes
Go to file
Yuval Kogman 4a93a8af94 Add unix shell script environment
Only contains shellcheck, couldn't find other projects like explainshell
or bash-language-server in nixpkgs
2023-05-26 01:21:02 +03:00
.github Add FUNDING.yml 2022-07-29 18:29:57 +02:00
clojure Stable release 22.11 2023-03-06 13:28:29 +02:00
cue Stable release 22.11 2023-03-06 13:28:29 +02:00
dhall Stable release 22.11 2023-03-06 13:28:29 +02:00
elixir Stable release 22.11 2023-03-06 13:28:29 +02:00
elm Stable release 22.11 2023-03-06 13:28:29 +02:00
gleam Stable release 22.11 2023-03-06 13:28:29 +02:00
go Stable release 22.11 2023-03-06 13:28:29 +02:00
hashi Stable release 22.11 2023-03-06 13:28:29 +02:00
haskell Stable release 22.11 2023-03-06 13:28:29 +02:00
java Stable release 22.11 2023-03-06 13:28:29 +02:00
kotlin Stable release 22.11 2023-03-06 13:28:29 +02:00
nickel Stable release 22.11 2023-03-06 13:28:29 +02:00
nim Stable release 22.11 2023-03-06 13:28:29 +02:00
nix Stable release 22.11 2023-03-06 13:28:29 +02:00
node Stable release 22.11 2023-03-06 13:28:29 +02:00
ocaml Stable release 22.11 2023-03-06 13:28:29 +02:00
opa Stable release 22.11 2023-03-06 13:28:29 +02:00
php Stable release 22.11 2023-03-06 13:28:29 +02:00
protobuf Stable release 22.11 2023-03-06 13:28:29 +02:00
purescript Stable release 22.11 2023-03-06 13:28:29 +02:00
python Stable release 22.11 2023-03-06 13:28:29 +02:00
ruby Stable release 22.11 2023-03-06 13:28:29 +02:00
rust Stable release 22.11 2023-03-06 13:28:29 +02:00
rust-toolchain Stable release 22.11 2023-03-06 13:28:29 +02:00
scala Stable release 22.11 2023-03-06 13:28:29 +02:00
shell Add unix shell script environment 2023-05-26 01:21:02 +03:00
zig Stable release 22.11 2023-03-06 13:28:29 +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 unix shell script environment 2023-05-26 01:21:02 +03:00
flake.lock Stable release 22.11 2023-03-06 13:28:29 +02:00
flake.nix Add unix shell script environment 2023-05-26 01:21:02 +03: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}

Note: All templates are pinned to the 22.11 release of Nixpkgs.

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
PHP php
Protobuf protobuf
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

cue

dhall

elixir

elm

gleam

go

hashi

haskell

java

kotlin

nickel

nim

nix

node

ocaml

opa

php

protobuf

purescript

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

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.