[ENH] Add pre-commit hooks (#68)

* add pre-commit hook

Signed-off-by: Jaron Lee <[email protected]>

* update pr number

Signed-off-by: Jaron Lee <[email protected]>

* update contributing with pre commit hook info

Signed-off-by: Jaron Lee <[email protected]>

---------

Signed-off-by: Jaron Lee <[email protected]>
Co-authored-by: Adam Li <[email protected]>

Author: jaron-lee

.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+# Install pre-commit hooks via
+# pre-commit install
+
+repos:
+  - repo: https://github.com/floatingpurr/sync_with_poetry
+    rev: "0.4.0" # the revision or tag to clone at
+    hooks:
+      - id: sync_with_poetry
+        args: ["--all"] # optional args
+  - repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: isort (python)
+        args: ["--profile", "black", "--filter-files", "--skip", "__init__.py"]
+        files: ^dodiscover/
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.4
+    hooks:
+      - id: bandit
+        args: ["-r", "dodiscover"]
+  - repo: https://github.com/PyCQA/flake8
+    rev: "6.0.0"
+    hooks:
+      - id: flake8
+  - repo: https://github.com/pre-commit/mirrors-mypy 
+    rev: "v0.971"
+    hooks:
+      - id: mypy
+        name: mypy (dodiscover)
+        args: ["--config-file", "pyproject.toml"]
+        files: ^dodiscover/
+  - repo: https://github.com/pre-commit/mirrors-mypy 
+    rev: "v0.971"
+    hooks:
+      - id: mypy
+        name: mypy (tests)
+        args: ["--config-file", "pyproject.toml"]
+        files: ^tests/
+

CONTRIBUTING.md

@@ -162,6 +162,14 @@ Finally, you should run some mypy type checks:
 
     poetry run poe type_check
 
+### Pre-commit Hooks
+
+To improve development workflows, you can use pre-commit hooks that automatically check for all of the `poe` tasks above:
+    
+    pre-commit install
+
+Whenever a commit is performed, these hooks will run to ensure that the code satisfies all formatting, style, and test checks.
+
 ### Documentation
 
 If you need to build the documentation locally and check for doc errors:
@@ -174,4 +182,4 @@ If you need to add new, or remove old dependencies, then you need to modify the
 
     poetry update
 
-To update the lock file.
+To update the lock file.

docs/whats_new/v0.1.rst

@@ -42,6 +42,7 @@ Changelog
 - |Feature| Implement export/import functions to go to/from pywhy-graphs to causallearn and to/from pywhy-graphs to numpy, by `Adam Li`_ (:pr:`51`)
 - |Feature| Implement export/import functions to go to/from pywhy-graphs to pcalg and tetrad, by `Adam Li`_ (:pr:`60`)
 - |Feature| Implement export/import functions to go to/from pywhy-graphs to ananke-causal, by `Jaron Lee`_ (:pr:`63`)
+- |Feature| Implement pre-commit hooks for development, by `Jaron Lee`_ (:pr:`68`)
 
 Code and Documentation Contributors
 -----------------------------------