Install pre-commit for repository

- Ensure we are formatting properly and consistently
  - Users can in principle choose to opt out of automatic hooks by not
    installing the tool in the repo
- Simplicity of incluing linting into CI
  - For stability we run them initially in parallel to existing linting
    scripts
- Scalability and futher development is simple as we can use existing
  solutions instead of implementing our own linting setup

Author: TheOneFromNorway

.github/workflows/lint.yml

@@ -70,3 +70,17 @@ jobs:
           terraform_version: 1.10.5
       - name: Check formatting
         run: terraform fmt -check -recursive
+
+  pre-commit:
+    name: Pre-commit
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: hashicorp/setup-terraform@v3
+        with:
+          terraform_version: 1.10.5
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: .tool-versions
+      - uses: pre-commit/action@v3.0.1

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/antonbabenko/pre-commit-terraform
+    rev: v1.99.0
+    hooks:
+      - id: terraform_fmt
+        files: \.(tf|tfvars|hcl)$

.tool-versions

@@ -5,3 +5,4 @@ aws-copilot 1.34.0
 awscli 2.13.31
 terraform 1.10.5
 tflint 0.55.1
+python 3.13.2

README.md

@@ -309,14 +309,34 @@ brew install libyaml
 # Dependencies for postgres
 brew install gcc readline zlib curl ossp-uuid icu4c pkg-config
 
+# Install pre-commit tool
+brew install pre-commit
+
 # Env vars for postgres
 export OPENSSL_PATH=$(brew --prefix openssl)
 export CMAKE_PREFIX_PATH=$(brew --prefix icu4c)
 export PATH="$OPENSSL_PATH/bin:$CMAKE_PREFIX_PATH/bin:$PATH"
 export LDFLAGS="-L$OPENSSL_PATH/lib $LDFLAGS"
 export CPPFLAGS="-I$OPENSSL_PATH/include $CPPFLAGS"
 export PKG_CONFIG_PATH="$CMAKE_PREFIX_PATH/lib/pkgconfig"
+```
+
+For ubuntu run
+
+```shell
+apt install curl libyaml-dev libreadline-dev zlib1g-dev \
+libssl-dev libicu-dev cmake pkg-config uuid-dev flex bison \
+pre-commit
+
+export OPENSSL_PATH="/usr"
+export CMAKE_PREFIX_PATH="/usr"
+export PATH="$OPENSSL_PATH/bin:$CMAKE_PREFIX_PATH/bin:$PATH"
+export LDFLAGS="-L$OPENSSL_PATH/lib $LDFLAGS"
+export CPPFLAGS="-I$OPENSSL_PATH/include $CPPFLAGS"
+export PKG_CONFIG_PATH="$CMAKE_PREFIX_PATH/lib/pkgconfig"
+```
 
+```shell
 # Version manager
 brew install mise
 
@@ -329,6 +349,13 @@ Then to install the required tools (or update, following a change to
 
 ```shell
 mise install
+mise exec python -- pip install pre-commit
+```
+
+Next ensure you have the pre-commit hook installed by running
+
+```shell
+pre-commit install
 ```
 
 After installing Postgres via `mise`, run the database in the background, and