Merge pull request #3 from hardcoretech/chore/bump_version

chore(missing): bump to version v0.2.5
hardcoretech · May 17, 2022 · 7d3bef0 · 7d3bef0
2 parents 72a4971 + 3b652dd
commit 7d3bef0
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,53 @@
 # Missing #
-The simple [pre-commit][0] hook to find the missing but necessary files.
+
+A simple [pre-commit][0] hook to find missing `__init__.py` that is required for unit test cases to be discovered.
 
 ## Example ##
+
+Default setting, everything except `.git` will be scanned
+
+```yaml
+- repo: https://github.com/hardcoretech/missing
+  rev: v0.2.5
+  hooks:
+    - id: missing-init-py
+```
+
+Exclude according to .gitignore
+
+```yaml
+- repo: https://github.com/hardcoretech/missing
+  rev: v0.2.5
+  hooks:
+    - id: missing-init-py
+      args:
+        - --mode
+        - obey_gitignore
+```
+
+Only include git staged files
+
+```yaml
+- repo: https://github.com/hardcoretech/missing
+  rev: v0.2.5
+  hooks:
+    - id: missing-init-py
+      args:
+        - --mode
+        - staged_only
+```
+
+Exclude frontend and doc folder
+
 ```yaml
 - repo: https://github.com/hardcoretech/missing
-  rev: v0.2.4
+  rev: v0.2.5
   hooks:
     - id: missing-init-py
+      args:
+        - --exclude
+        - frontend
+        - doc
 ```
 
 [0]: https://pre-commit.com/
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "missing"
-version = "0.2.4"
+version = "0.2.5"
 description = ""
 authors = ["PLM <[email protected]>"]