Merge pull request #28 from biocommons/12-add-precommit-hook-support

Add pre-commit hook

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+- repo: local
+  hooks:
+    -  id: flake8
+       name: flake8
+       entry: flake8
+       language: system
+       types: [python]
+    -  id: isort
+       name: isort
+       entry: isort
+       language: system
+       types: [python]
+    -  id: black
+       name: black
+       entry: black
+       language: system
+       types: [python]

Makefile

@@ -5,7 +5,7 @@
 .PRECIOUS:
 .SUFFIXES:
 
-SHELL:=/bin/bash -e -o pipefail -O globstar
+SHELL:=/bin/bash -e -o pipefail #-O globstar
 SELF:=$(firstword $(MAKEFILE_LIST))
 
 VE_DIR=venv
@@ -45,6 +45,7 @@ ${VE_DIR}:
 .PHONY: develop
 develop:
 	pip install -e .[dev]
+	pre-commit install
 
 #=> install: install package
 .PHONY: install

README.md

@@ -24,6 +24,11 @@ Code reformatting:
 
     make reformat
 
+Install pre-commit hook:
+
+    # included in `make devready`, not necessary for new installations
+    pre-commit install
+
 Test:
 
     make test   # for current environment

pyproject.toml

@@ -76,6 +76,10 @@ exclude_lines = [
 [tool.black]
 line-length = 100
 
+[tool.isort]
+profile = "black"
+src_paths = ["src"]
+
 
 # [tool.flake8]
 # flake8 does not support configuration in pyproject.toml

setup.cfg

@@ -18,6 +18,7 @@ dev =
     ipython~=8.4
     isort~=5.10
     mypy
+    pre-commit~=3.4
     pylint~=2.14
     pytest-cov~=4.1
     pytest-optional-tests