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
  - For current solutions we add them directly to the pre-commit config
    to ensure stability & consistency

Author: TheOneFromNorway

.github/workflows/lint.yml

@@ -57,3 +57,29 @@ jobs:
         with:
           bundler-cache: true
       - run: bin/bundle exec brakeman
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .tool-versions
+          cache: yarn
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - uses: hashicorp/setup-terraform@v3
+        with:
+          terraform_version: 1.10.5
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - uses: terraform-linters/setup-tflint@v4
+      - run: yarn install --immutable --immutable-cache --check-cache
+      - name: Install pre-commit
+        run: pip install pre-commit
+      - name: Run pre-commit
+        run: pre-commit run --all-files --hook-stage manual

.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+repos:
+  - repo: https://github.com/antonbabenko/pre-commit-terraform
+    rev: v1.97.3
+    hooks:
+      - id: terraform_fmt
+        files: \.(tf|tfvars|hcl)$
+      - id: terraform_tflint
+        stages: [manual]
+        args:
+          - --args=--config=__GIT_WORKING_DIR__/terraform/.tflint.hcl
+        files: \.tf$
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: \.(enc|erb)$
+      - id: end-of-file-fixer
+        exclude: \.(enc|erb)$
+      - id: check-json
+      - id: check-added-large-files # Default is fail on files larger than 500kB
+      - id: mixed-line-ending
+        args: [--fix=lf] # Ensure all line endings are LF
+        exclude: \.csv$
+  - repo: local
+    hooks:
+      - id: prettier
+        name: Prettier
+        entry: |
+          yarn prettier --check --ignore-unknown '**/*'
+        language: system
+        pass_filenames: false
+        stages: [manual]
+      - id: rubocop
+        name: Rubocop
+        entry: bin/bundle exec rubocop --autocorrect-all $*
+        language: system
+        files: ^app/
+        types: [ruby]
+        stages: [manual]
+      - id: rufo
+        name: Rufo
+        entry: bin/bundle exec rufo --check app
+        language: system
+        pass_filenames: false
+        stages: [manual]
+      - id: brakeman
+        name: Brakeman
+        entry: bin/bundle exec brakeman --no-pager .
+        language: system
+        always_run: true
+        pass_filenames: false
+        stages: [manual]

.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

terraform/.tflint.hcl

@@ -0,0 +1,9 @@
+plugin "terraform" {
+  enabled = true
+}
+
+plugin "aws" {
+  enabled = true
+  version = "0.37.0"
+  source  = "github.com/terraform-linters/tflint-ruleset-aws"
+}