Run lint with pre-commit (#1546)

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.8.0
+    hooks:
+      - id: isort
+
+  - repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: pylint
+        language: system
+        types: [python]
+        args:
+          [
+            "-rn",
+            "-j0",
+            "--rcfile=.pylintrc",
+          ]
+        exclude: ^(docs/|changelog.py)
+        require_serial: true

Makefile

@@ -91,13 +91,10 @@ tox-env-clean:
 	rm -rf .tox
 
 lint: check-venv
-	@. $(VENV_ACTIVATE_FILE); find esrally benchmarks scripts tests it -name "*.py" -exec pylint -j0 -rn --rcfile=$(CURDIR)/.pylintrc \{\} +
-	@. $(VENV_ACTIVATE_FILE); black --check --diff .
-	@. $(VENV_ACTIVATE_FILE); isort --check --diff .
+	@. $(VENV_ACTIVATE_FILE); pre-commit run --all-files
 
-format: check-venv
-	@. $(VENV_ACTIVATE_FILE); black .
-	@. $(VENV_ACTIVATE_FILE); isort .
+# pre-commit run also formats files, but let's keep `make format` for convenience
+format: lint
 
 docs: check-venv
 	@. $(VENV_ACTIVATE_FILE); cd docs && $(MAKE) html

docs/developing.rst

@@ -34,6 +34,8 @@ Rally uses automatic code formatters. They're enforced by ``make lint`` and you
 
 However, consider using editor integrations to do it automatically: you'll need to configure `black <https://black.readthedocs.io/en/stable/integrations/editors.html>`_ and `isort <https://github.com/PyCQA/isort/wiki/isort-Plugins>`_.
 
+Also consider running `pre-commit install` to run lint as part of your git commits.
+
 Automatic Updates
 ~~~~~~~~~~~~~~~~~
 

pyproject.toml

@@ -99,9 +99,8 @@ develop = [
     "twine==1.15.0",
     "wheel==0.37.1",
     "github3.py==1.3.0",
+    "pre-commit==2.20.0",
     "pylint==2.6.0",
-    "black==22.3.0",
-    "isort==5.8.0",
     "trustme==0.9.0",
     "pytest-httpserver==1.0.4",
 ]