Add pre-commit to run spotlessApply automatically before git commit (#…

…331) * Test * WIP * Test * Test * Test * Test * Test * Test * Test * test * Update README * Test * Test * pre-push * Test * Test * Test * Test * Test * Test * Testr * Test
dydxprotocol · May 3, 2024 · 243b71d · 243b71d
1 parent 56aec55
commit 243b71d
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,14 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+default_install_hook_types:
+   [pre-push]
+
+repos:
+-   repo: local
+    hooks:
+    -   id: spotless-apply
+        name: spotless-apply
+        entry: ./run_spotless_apply.sh
+        language: script
+        stages: [pre-push]
diff --git a/README.md b/README.md
@@ -87,6 +87,13 @@ Integration tests can be written to call Abacus from non-Kotlin code (i.e., Swif
 
 > ./bump_version.sh
 
+# Auto-lint
+
+Enable pre-commit to auto-lint/auto-format your changes before git commit:
+
+> brew install pre-commit
+> pre-commit install
+
 # How to use
 
 ```

diff --git a/run_spotless_apply.sh b/run_spotless_apply.sh
@@ -0,0 +1,5 @@
+#!/bin/sh
+
+./gradlew spotlessApply
+
+exit 0