Merge pull request #168 from Solmath/feature/pre-commit-code-formatting

Code formatting and pre-commit support

Author: ph1p

.clang-format

@@ -0,0 +1,15 @@
+---
+BasedOnStyle: Microsoft
+AllowAllArgumentsOnNextLine: 'false'
+AllowAllParametersOfDeclarationOnNextLine: 'false'
+BinPackArguments: 'false'
+BinPackParameters: 'false'
+ColumnLimit: '102'
+ExperimentalAutoDetectBinPacking: 'false'
+IndentWidth: '2'
+Language: Cpp
+# Force pointers to the type for C++.
+DerivePointerAlignment: 'true'
+PointerAlignment: Right
+
+...

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v21.1.2
+    hooks:
+    -   id: clang-format
+        types_or: [c++, c]
+        exclude: lib/

README.md

@@ -530,6 +530,15 @@ curl http://your-server/api/clearstorage
 - Build frontend using `Docker`
   - From the root of the repo, run `docker compose run node`
 
+- Please use the provided pre-commit hooks
+
+  - Install [pre-commit](https://pre-commit.com/)
+  - Activate the hooks by running
+
+  ```bash
+  pre-commit install
+  ```
+
 # Plugin Development
 
 1. Start by creating a new C++ file for your plugin. For example, let's call it plugins/MyPlugin.(cpp/h).