chore: adding nix, update pre-commit

Author: florianow

.gitignore

@@ -1,31 +1,3 @@
-# Local .terraform directories
-**/.terraform/*
-
-# .tfstate files
-*.tfstate
-*.tfstate.*
-
-# Crash log files
-crash.log
-
-# Ignore any .tfvars files that are generated automatically for each Terraform run. Most
-# .tfvars files are managed as part of configuration and so should be included in
-# version control.
-#
-# example.tfvars
-
-# Ignore override files as they are usually used to override resources locally and so
-# are not checked in
-override.tf
-override.tf.json
-*_override.tf
-*_override.tf.json
-
-# Include override files you do wish to add to version control using negated pattern
-#
-# !example_override.tf
-
-# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
-# example: *tfplan*
-.terraform.*
-.terraform
+.terraform
+.terraform.lock.hcl
+terraform.tfstate*

.pre-commit-config.yaml

@@ -1,10 +1,13 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v1.2.3
+    rev: v5.0.0
     hooks:
     - id: trailing-whitespace
 -   repo: https://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.73.0
+    rev: v1.98.1
     hooks:
         - id: terraform_fmt
         - id: terraform_validate
+        - id: terraform_docs
+          args:
+            - --args=--config=.terraform-docs.yml

.terraform-docs.yml

@@ -0,0 +1,25 @@
+formatter: "markdown" # this is required
+
+version: ""
+
+recursive:
+  enabled: false
+  path: modules
+
+content: ""
+
+output:
+  file: "README.md"
+  mode: inject
+  template: |-
+    <!-- BEGIN_TF_DOCS -->
+    {{ .Content }}
+    <!-- END_TF_DOCS -->
+
+sort:
+  enabled: true
+  by: name
+
+sections:
+  hide: # we remove the providers section because the actual provider used depends on the local build environment, we only document version constraints
+    - providers

default.nix

@@ -0,0 +1,35 @@
+{ pkgs ? import <nixpkgs> { }, system ? builtins.currentSystem }:
+
+let
+  # fake opentofu as terraform so that tools like terraform-docs pre-commit hook (which doesn't have tofu support)
+  # fall back to tofu
+  tofu_terraform =
+    pkgs.stdenv.mkDerivation {
+      name = "tofu-terraform";
+      phases = [ "installPhase" ];
+      installPhase = ''
+        mkdir -p $out/bin
+        echo '#!/usr/bin/env sh' > $out/bin/terraform
+        echo 'tofu $@' > $out/bin/terraform
+        chmod +x $out/bin/terraform
+      '';
+    };
+
+in
+
+pkgs.mkShell {
+  NIX_SHELL = "terraform-meshplatform-modules";
+  shellHook = ''
+    echo starting terraform-meshplatform-modules shell
+  '';
+
+  buildInputs = [
+    pkgs.pre-commit
+    pkgs.opentofu
+    pkgs.tflint
+    pkgs.terraform-docs
+
+    # fake tofu as terraform
+    tofu_terraform
+  ];
+}