Add Terraform Nix template

.envrc

@@ -1,7 +1,6 @@
-watch_file devenv.nix
-watch_file devenv.yaml
-watch_file devenv.lock
-watch_file result/bin/devenv
-watch_dir src
-nix-build
-eval "$(./result/bin/devenv print-dev-env)"
+source_url "https://raw.githubusercontent.com/cachix/devenv/5811f4817ba24da923506d134fff2610b8f95ff2/direnvrc" "sha256-IN2rc7pbaBxxjcdIpYOe9lkpiyjSr2V2AwF6KwlnWYQ="
+
+# use our own last built devenv/nix in CLI
+PATH_add result/bin
+
+use devenv

.github/workflows/buildtest.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
-    - uses: cachix/install-nix-action@v19
+    - uses: cachix/install-nix-action@v20
       with:
         extra_nix_config: |
           access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
@@ -52,7 +52,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
-    - uses: cachix/install-nix-action@v19
+    - uses: cachix/install-nix-action@v20
       with:
         extra_nix_config: |
           access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
@@ -82,7 +82,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
-    - uses: cachix/install-nix-action@v19
+    - uses: cachix/install-nix-action@v20
       with:
         nix_path: nixpkgs=channel:nixos-unstable
     - uses: cachix/cachix-action@v12

.github/workflows/generate.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: cachix/install-nix-action@v18
+    - uses: cachix/install-nix-action@v20
       with:
         extra_nix_config: |
           access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -6,3 +6,4 @@ result
 /include
 /lib
 pyvenv.cfg
+/.direnv

devenv.lock

@@ -104,11 +104,11 @@
     },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1676549890,
-        "narHash": "sha256-sq/WcOEAl7gWrrfGkWdnyYazRyTf+enEim/o6LOQzI8=",
+        "lastModified": 1677534593,
+        "narHash": "sha256-PuZSAHeq4/9pP/uYH1FcagQ3nLm/DrDrvKi/xC9glvw=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "8c66bd1b68f4708c90dcc97c6f7052a5a7b33257",
+        "rev": "3ad64d9e2d5bf80c877286102355b1625891ae9a",
         "type": "github"
       },
       "original": {
@@ -161,11 +161,11 @@
         "nixpkgs-stable": "nixpkgs-stable"
       },
       "locked": {
-        "lastModified": 1676513100,
-        "narHash": "sha256-MK39nQV86L2ag4TmcK5/+r1ULpzRLPbbfvWbPvIoYJE=",
+        "lastModified": 1677160285,
+        "narHash": "sha256-tBzpCjMP+P3Y3nKLYvdBkXBg3KvTMo3gvi8tLQaqXVY=",
         "owner": "cachix",
         "repo": "pre-commit-hooks.nix",
-        "rev": "5f0cba88ac4d6dd8cad5c6f6f1540b3d6a21a798",
+        "rev": "2bd861ab81469428d9c823ef72c4bb08372dd2c4",
         "type": "github"
       },
       "original": {

devenv.nix

@@ -9,19 +9,20 @@
   ];
 
   languages.python.enable = true;
+  languages.python.venv.enable = true;
 
   devcontainer.enable = true;
   difftastic.enable = true;
 
   # bin/mkdocs serve --config-file mkdocs.insiders.yml
-  processes.docs.exec = "bin/mkdocs serve";
+  processes.docs.exec = "mkdocs serve";
   processes.build.exec = "${pkgs.watchexec}/bin/watchexec -e nix nix build";
 
   enterShell = ''
     echo "To Install:"
     echo
-    echo "virtualenv ."
-    echo "bin/pip install -r requirements.txt"
+    echo "  $ pip install -r requirements.txt"
+    echo
   '';
 
   scripts.devenv-bump-version.exec = ''

devenv.yaml

@@ -12,4 +12,4 @@ inputs:
     url: github:cachix/pre-commit-hooks.nix
     inputs:
       nixpkgs:
-        follows: "nixpkgs"
+        follows: "nixpkgs"

direnvrc

@@ -0,0 +1,154 @@
+# shellcheck shell=bash
+# adapted from https://github.com/nix-community/nix-direnv/blob/master/direnvrc
+
+REQUIRED_DIRENV_VERSION="2.21.3"
+
+_nix_direnv_preflight () {
+  if [[ -z "$direnv" ]]; then
+    printf '%s\n' "\$direnv environment variable was not defined. Was this script run inside direnv?"
+    exit 1
+  fi
+
+  if [[ -z ${DEVENV_BIN:-} ]]; then
+    DEVENV_BIN=$(command -v devenv)
+    if [[ -z "${DEVENV_BIN}" ]]; then
+      log_status "command not found: devenv, see https://devenv.sh/getting-started/"
+      exit 1
+    fi
+  fi
+
+  if ! has direnv_version || ! direnv_version "$REQUIRED_DIRENV_VERSION" 2>/dev/null; then
+    log_status "base direnv version is older than the required v$REQUIRED_DIRENV_VERSION."
+    exit 1
+  fi
+
+  local layout_dir
+  layout_dir=$(direnv_layout_dir)
+
+  if [[ ! -d "$layout_dir" ]]; then
+    mkdir -p "$layout_dir"
+  fi
+}
+
+_nix_export_or_unset() {
+  local key=$1 value=$2
+  if [[ "$value" == __UNSET__ ]]; then
+    unset "$key"
+  else
+    export "$key=$value"
+  fi
+}
+
+_nix_import_env() {
+  local profile_rc=$1
+
+  local old_nix_build_top=${NIX_BUILD_TOP:-__UNSET__}
+  local old_tmp=${TMP:-__UNSET__}
+  local old_tmpdir=${TMPDIR:-__UNSET__}
+  local old_temp=${TEMP:-__UNSET__}
+  local old_tempdir=${TEMPDIR:-__UNSET__}
+  local old_xdg_data_dirs=${XDG_DATA_DIRS:-}
+  eval "$(< "$profile_rc")"
+  # `nix print-dev-env` will create a temporary directory and use it as TMPDIR
+  # We cannot rely on this directory being availble at all times,
+  # as it may be garbage collected.
+  # Instead - just remove it immediately.
+  # Use recursive & force as it may not be empty.
+  if [[ -n "${NIX_BUILD_TOP+x}" && "$NIX_BUILD_TOP" == */nix-shell.* && -d "$NIX_BUILD_TOP" ]]; then
+    rm -rf "$NIX_BUILD_TOP"
+  fi
+
+  _nix_export_or_unset NIX_BUILD_TOP "$old_nix_build_top"
+  _nix_export_or_unset TMP "$old_tmp"
+  _nix_export_or_unset TMPDIR "$old_tmpdir"
+  _nix_export_or_unset TEMP "$old_temp"
+  _nix_export_or_unset TEMPDIR "$old_tempdir"
+  local new_xdg_data_dirs=${XDG_DATA_DIRS:-}
+  export XDG_DATA_DIRS=
+  local IFS=:
+  for dir in $new_xdg_data_dirs${old_xdg_data_dirs:+:}$old_xdg_data_dirs; do
+    dir="${dir%/}" # remove trailing slashes
+    if [[ :$XDG_DATA_DIRS: = *:$dir:* ]]; then
+      continue # already present, skip
+    fi
+    XDG_DATA_DIRS="$XDG_DATA_DIRS${XDG_DATA_DIRS:+:}$dir"
+  done
+}
+
+_nix_argsum_suffix() {
+  local out checksum content
+
+  content=$(cat "$@" 2>/dev/null)
+
+  if has sha1sum; then
+    out=$(sha1sum <<< "$content")
+  elif has shasum; then
+    out=$(shasum <<< "$content")
+  else
+    log_status "not hashing your cache, please install sha1sum"
+    # degrate gracefully both tools are not present
+    return
+  fi
+  read -r checksum _ <<< "$out"
+  echo "-$checksum"
+}
+
+nix_direnv_watch_file() {
+  watch_file "$@"
+  nix_watches+=("$@")
+}
+
+use_devenv() {
+  _nix_direnv_preflight
+
+  flake_expr="${1:-.}"
+  flake_dir="${flake_expr%#*}"
+
+  local files_to_watch
+  files_to_watch=(".envrc" "$HOME/.direnvrc" "$HOME/.config/direnv/direnvrc")
+
+  if [[ -d "$flake_dir" ]]; then
+    files_to_watch+=("$flake_dir/devenv.nix" "$flake_dir/devenv.lock" "$flake_dir/devenv.yaml" "$flake_dir/devenv.local.nix")
+    if [[ -f "$flake_dir/devenv.yaml" ]]; then
+      if ! devenv assemble; then
+        log_status "$(devenv version) failed to parse devenv.yaml, make sure to use version 0.6 or newer and fix the errors above."
+        exit 1
+      fi
+
+      if [[ -f "$flake_dir/.devenv/imports.txt" ]]; then
+        for file in $(cat "$flake_dir/.devenv/imports.txt"); do
+            files_to_watch+=("$file")
+        done
+      fi
+    fi
+  fi
+
+  nix_direnv_watch_file "${files_to_watch[@]}"
+
+  local layout_dir profile_rc
+  layout_dir=$(direnv_layout_dir)
+  profile_rc="${layout_dir}/devenv-profile$(_nix_argsum_suffix "${files_to_watch[@]}").rc"
+
+  local need_update=0
+  local file=
+  for file in "${nix_watches[@]}"; do
+    if [[ "$file" -nt "$profile_rc" ]]; then
+      need_update=1
+      log_status "$file changed, reloading"
+      break
+    fi
+  done
+
+  if [[ ! -e "$profile_rc" || "$need_update" == "1" ]];
+  then
+    # We need to update our cache
+    local tmp_profile_rc
+    tmp_profile_rc=$("${DEVENV_BIN}" print-dev-env)
+    echo "$tmp_profile_rc" > "$profile_rc"
+    log_status "updated devenv shell cache"
+  else
+    log_status "using cached devenv shell"
+  fi
+
+  _nix_import_env "$profile_rc"
+}