From d5017f879ab5e8db7ca7104909d7cf1bdd0954f4 Mon Sep 17 00:00:00 2001
From: JP-Ellis <josh@jpellis.me>
Date: Thu, 14 Sep 2023 11:22:58 +1000
Subject: [PATCH] style: add pre-commit hooks and editorconfig

Without wanting to overload the pre-commit hooks, this adds a few checks
on the commits to ensure validity of files.

More time-consuming checks for linting and formatting are done pre-push
to avoid impacting the developer experience during local development.
These are covered by `prettier` (for markdown, yaml, json, ...), `black`
for Python and `ruff` for Python linting.

To help standardise formatting in the future, an `.editorconfig` file
has also been added to the repository.

By virtue of using `pre-commit`, only modified files are checked which
ensures older files are incrementally updated.

Signed-off-by: JP-Ellis <josh@jpellis.me>
---
 .editorconfig           | 22 ++++++++++++++++++
 .pre-commit-config.yaml | 51 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 73 insertions(+)
 create mode 100644 .editorconfig

diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 000000000..acd41cef1
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,22 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+indent_size = 4
+
+[Makefile]
+indent_size = 4
+indent_style = tab
+
+[*.md]
+indent_size = 4
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 3ff4f8937..3ddd02d1c 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,4 +1,55 @@
+default_install_hook_types:
+  - commit-msg
+  - pre-commit
+  - pre-push
+
 repos:
+  # Generic hooks that apply to a lot of files
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: destroyed-symlinks
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+      # The following only check that the files are parseable and does _not_
+      # modify the formatting.
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+
+  - repo: https://gitlab.com/bmares/check-json5
+    rev: v1.0.0
+    hooks:
+      # As above, this only checks for valid JSON files. This implementation
+      # allows for comments within JSON files.
+      - id: check-json5
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.3
+    hooks:
+      - id: prettier
+        stages: [pre-push]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.289
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+        stages: [pre-push]
+
+  - repo: https://github.com/psf/black
+    rev: 23.9.1
+    hooks:
+      - id: black
+        stages: [pre-push]
+
   - repo: https://github.com/commitizen-tools/commitizen
     rev: master
     hooks: