feat: Adding terragrunt hcl fmt script (#134)

* feat: Adding `terragrunt hcl fmt` script

* fix: Fixing `.pre-commit-hooks.yaml`

* fix: Updating hook logic

Author: yhakbar

.pre-commit-hooks.yaml

@@ -64,6 +64,18 @@
       \.terragrunt-cache\/.*|
     )$
 
+- id: terragrunt-hcl-fmt
+  name: Terragrunt hcl fmt
+  description: Rewrites all Terragrunt configuration files to a canonical format
+  entry: hooks/terragrunt-hcl-fmt.sh
+  language: script
+  files: \.hcl$
+  exclude: >
+    (?x)^(
+      \.terraform\/.*|
+      \.terragrunt-cache\/.*|
+    )$
+
 - id: shellcheck
   name: Shellcheck Bash Linter
   description: Performs linting on bash scripts
@@ -99,7 +111,6 @@
   description: golangci-lint is a Go linters aggregator
   entry: hooks/golangci-lint.sh
   language: script
-  language: script
   files: \.go$
   require_serial: true
 

README.md

@@ -10,7 +10,8 @@ supported hooks are:
 * **terraform-fmt**: Automatically run `terraform fmt` on all Terraform code (`*.tf` files).
 * **terraform-validate**: Automatically run `terraform validate` on all Terraform code (`*.tf` files).
 * **packer-validate**: Automatically run `packer validate` on all Packer code (`*.pkr.*` files).
-* **terragrunt-hclfmt**: Automatically run `terragrunt hclfmt` on all Terragrunt configurations.
+* **terragrunt-hclfmt**: Automatically run `terragrunt hclfmt` on all Terragrunt configurations (deprecated, use `terragrunt-hcl-fmt` instead if you are using Terragrunt 0.77.22 or later).
+* **terragrunt-hcl-fmt**: Automatically run `terragrunt hcl fmt` on all Terragrunt configurations (requires Terragrunt 0.77.22 or later).
 * **tflint**: Automatically run [`tflint`](https://github.com/terraform-linters/tflint) on all OpenTofu/Terraform code (`*.tf`, `*.tofu` files).
 * **shellcheck**: Run [`shellcheck`](https://www.shellcheck.net/) to lint files that contain a bash [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)).
 * **gofmt**: Automatically run `gofmt` on all Golang code (`*.go` files).
@@ -23,10 +24,6 @@ supported hooks are:
   markdown doc files.
 * **sentinel-fmt**: Automatically run `sentinel fmt` on all Sentinel code (`*.sentinel.*` files).
 
-
-
-
-
 ## General Usage
 
 In each of your repos, add a file called `.pre-commit-config.yaml` with the following contents:
@@ -44,19 +41,15 @@ repos:
       - id: golint
 ```
 
-Next, have every developer: 
+Next, have every developer:
 
 1. Install [pre-commit](http://pre-commit.com/). E.g. `brew install pre-commit`.
 1. Run `pre-commit install` in the repo.
 
 That’s it! Now every time you commit a code change (`.tf` file), the hooks in the `hooks:` config will execute.
 
-
-
-
 ## Running Against All Files At Once
 
-
 ### Example: Formatting all files
 
 If you'd like to format all of your code at once (rather than one file at a time), you can run:
@@ -65,8 +58,6 @@ If you'd like to format all of your code at once (rather than one file at a time
 pre-commit run tofu-fmt --all-files
 ```
 
-
-
 ### Example: Enforcing in CI
 
 If you'd like to enforce all your hooks, you can configure your CI build to fail if the code doesn't pass checks by
@@ -81,9 +72,6 @@ pre-commit run --all-files
 If all the hooks pass, the last command will exit with an exit code of 0. If any of the hooks make changes (e.g.,
 because files are not formatted), the last command will exit with a code of 1, causing the build to fail.
 
-
-
-
 ## Helm Lint Caveats
 
 ### Detecting charts
@@ -129,7 +117,7 @@ containerImage: nginx
 
 Now when the pre-commit hook runs, it will call `helm lint` with both `linter_values.yaml` and `values.yaml`:
 
-```
+```bash
 helm lint -f values.yaml -f linter_values.yaml .
 ```
 
@@ -153,7 +141,7 @@ repos:
 
 With the introduction of `--chdir` into tflint, the `--config` argument is now bound to whatever subdirectory you are
 running the check against.  For mono-repos this isn't ideal as you may have a central configuration file you'd like to
-use.  If this matches your use-case, you can specify the placeholder `__GIT_ROOT__` value in the `--config` argument 
+use.  If this matches your use-case, you can specify the placeholder `__GIT_ROOT__` value in the `--config` argument
 that will evaluate to the root of the repository you are in.
 
 ```yaml

hooks/terragrunt-hcl-fmt.sh

@@ -0,0 +1,49 @@
+#!/usr/bin/env bash
+
+set -e
+
+# OSX GUI apps do not pick up environment variables the same way as Terminal apps and there are no easy solutions,
+# especially as Apple changes the GUI app behavior every release (see https://stackoverflow.com/q/135688/483528). As a
+# workaround to allow GitHub Desktop to work, add this (hopefully harmless) setting here.
+export PATH=$PATH:/usr/local/bin
+
+check_terragrunt_version() {
+  local minimum_supported_version="0.77.22"
+  local current_version
+
+  if ! command -v terragrunt >/dev/null 2>&1; then
+    echo "Warning: terragrunt command not found. Proceeding anyway..." >&2
+
+    return 0
+  fi
+
+  if ! current_version=$(terragrunt --version 2>/dev/null | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' | head -1); then
+    echo "Warning: Could not determine terragrunt version. Proceeding anyway..." >&2
+
+    return 0
+  fi
+
+  if [ "$(printf '%s\n' "$minimum_supported_version" "$current_version" | sort -V | head -1)" = "$minimum_supported_version" ]; then
+    return 0
+  fi
+
+  echo "Error: Terragrunt version $current_version is less than the minimum supported version $minimum_supported_version" >&2
+  echo "Please upgrade Terragrunt to version $minimum_supported_version or later" >&2
+
+  exit 1
+}
+
+format_files() {
+  for file in "$@"; do
+    pushd "$(dirname "$file")" >/dev/null
+    terragrunt hcl fmt --file "$(basename "$file")"
+    popd >/dev/null
+  done
+}
+
+main() {
+  check_terragrunt_version
+  format_files "$@"
+}
+
+main "$@"