✨ Support use of auto-optional as pre-commit hook (#11)

Luttik · Oct 8, 2021 · 47f4063 · 47f4063
1 parent 3f904c3
commit 47f4063
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml
@@ -0,0 +1,6 @@
+-   id: auto-optional
+    name: auto-optional
+    description: Adds the Optional type-hint to arguments where the default value is None
+    entry: auto-optional
+    language: python
+    types: [python]
diff --git a/README.md b/README.md
@@ -74,6 +74,19 @@ Install with `pip install auto-optional`.
 ## Run
 After installing you can run auto-optional using `auto-optional [path]` (path is an optional argument).
 
+## pre-commit
+
+You can run auto-optional via [pre-commit](https://pre-commit.com/).
+Add the following text to your repositories `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+- repo: https://github.com/luttik/auto-optional
+  rev: v0.2.0 # The version of auto-optional to use
+  hooks:
+  - id: auto-optional
+```
+
 ## Things of note
 
 ### Things that are handled well

diff --git a/docs/index.md b/docs/index.md
@@ -74,6 +74,19 @@ Install with `pip install auto-optional`.
 ## Run
 After installing you can run auto-optional using `auto-optional [path]` (path is an optional argument).
 
+## pre-commit
+
+You can run auto-optional via [pre-commit](https://pre-commit.com/).
+Add the following text to your repositories `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+- repo: https://github.com/luttik/auto-optional
+  rev: v0.2.0 # The version of auto-optional to use
+  hooks:
+  - id: auto-optional
+```
+
 ## Things of note
 
 ### Things that are handled well