Tweak linting target (#171)

* Makefile: split `lint` and `reformat` targets Signed-off-by: William Woodruff <william@trailofbits.com> * CONTRIBUTING: document `make reformat` Signed-off-by: William Woodruff <william@trailofbits.com>
sigstore · Jul 21, 2022 · a035704 · a035704
1 parent f35a621
commit a035704
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -51,6 +51,12 @@ make lint
 * [`interrogate`](https://interrogate.readthedocs.io/en/latest/): Documentation coverage
 
 
+To automatically apply any lint-suggested changes, you can run:
+
+```bash
+make reformat
+```
+
 ### Testing
 
 You can run the tests locally with:

diff --git a/Makefile b/Makefile
@@ -43,13 +43,17 @@ run:
 .PHONY: lint
 lint:
 	. env/bin/activate && \
-		black $(ALL_PY_SRCS) && \
-		isort $(ALL_PY_SRCS) && \
+		black --check $(ALL_PY_SRCS) && \
+		isort --check $(ALL_PY_SRCS) && \
 		flake8 $(ALL_PY_SRCS) && \
 		mypy $(PY_MODULE) && \
 		bandit -c pyproject.toml -r $(PY_MODULE)
 
-	  git diff --exit-code
+.PHONY: reformat
+reformat:
+	. env/bin/activate && \
+		black $(ALL_PY_SRCS) && \
+		isort $(ALL_PY_SRCS)
 
 .PHONY: test
 test: