Simplify the pre-commit hooks

- run "format" and "lint" separately
  => remove the nox session "pre-commit"
- execute the entire "test-suite" before merges
  + rename "pre-merge" into "test-suite"
  + do not "format" and "lint" here any more
  + do not execute this before pushes
    * allow branches with <100% test coverage to exist on GitHub
      (they cannot be merged into 'main' until 100% coverage)
    * GitHub Actions executes the test suite

.pre-commit-config.yaml

@@ -4,9 +4,15 @@ repos:
 # Run the local formatting, linting, and testing tool chains.
 - repo: local
   hooks:
-  - id: local-pre-commit-checks
+  - id: local-format
-    name: Run code formatters and linters
+    name: Format the source files
-    entry: poetry run nox -s pre-commit --
+    entry: poetry run nox -s format --
+    language: system
+    stages: [commit]
+    types: [python]
+  - id: local-lint
+    name: Lint the source files
+    entry: poetry run nox -s lint --
     language: system
     stages: [commit]
     types: [python]
@@ -16,12 +22,12 @@ repos:
     language: system
     stages: [commit]
     types: [text]
-  - id: local-pre-merge-checks
+  - id: local-test-suite
     name: Run the entire test suite
-    entry: poetry run nox -s pre-merge --
+    entry: poetry run nox -s test-suite --
     language: system
-    stages: [merge-commit, push]
+    stages: [merge-commit]
-    types: [python]
+    types: [text]
 # Enable hooks provided by the pre-commit project to
 # enforce rules that local tools could not that easily.
 - repo: https://github.com/pre-commit/pre-commit-hooks

noxfile.py

@@ -27,7 +27,7 @@ as unified tasks to assure the quality of the source code:
     => may be paths or options
 
 
-GitHub Actions implements a CI workflow:
+GitHub Actions implements the following CI workflow:
 
 - "format", "lint", and "test" as above
 
@@ -36,18 +36,14 @@ GitHub Actions implements a CI workflow:
 - "docs": build the documentation with sphinx
 
 
-The pre-commit framework invokes the "pre-commit" and "pre-merge" sessions:
+The pre-commit framework invokes the following tasks:
 
-- "pre-commit" before all commits:
+- before any commit:
 
-  + triggers "format" and "lint" on staged source files
+  + "format" and "lint" as above
-  + => test coverage may be < 100%
+  + "fix-branch-references": replace branch references with the current one
 
-- "pre-merge" before all merges and pushes:
+- before merges: run the entire "test-suite" independent of the file changes
-
-  + same as "pre-commit"
-  + plus: triggers "test", "safety", and "docs" (that ignore extra arguments)
-  + => test coverage is enforced to be 100%
 
 """
 
@@ -199,23 +195,6 @@ def lint(session):
     )
 
 
-@nox.session(name='pre-commit', python=PYTHON, venv_backend='none')
-def pre_commit(session):
-    """Run the format and lint sessions.
-
-    Source files must be well-formed before they enter git.
-
-    Intended to be run as a pre-commit hook.
-
-    Passed in extra arguments are forwarded. So, if it is run as a pre-commit
-    hook, only the currently staged source files are formatted and linted.
-    """
-    # "format" and "lint" are run in sessions on their own as
-    # session.notify() creates new Session objects.
-    session.notify('format')
-    session.notify('lint')
-
-
 @nox.session(python=PYTHON)
 def test(session):
     """Test the code base.
@@ -320,28 +299,22 @@ def docs(session):
     print(f'Docs are available at {os.getcwd()}/{DOCS_BUILD}index.html')  # noqa:WPS421
 
 
-@nox.session(name='pre-merge', python=PYTHON)
+@nox.session(name='test-suite', python=PYTHON)
-def pre_merge(session):
+def test_suite(session):
-    """Run the format, lint, test, safety, and docs sessions.
+    """Run the entire test suite.
 
-    Intended to be run either as a pre-merge or pre-push hook.
+    Intended to be run as a pre-commit hook.
 
     Ignores the paths passed in by the pre-commit framework
-    for the test, safety, and docs sessions so that the
+    and runs the entire test suite.
-    entire test suite is executed.
     """
     # Re-using an old environment is not so easy here as the "test" session
     # runs `poetry install --no-dev`, which removes previously installed packages.
     if session.virtualenv.reuse_existing:
         raise RuntimeError(
-            'The "pre-merge" session must be run without the "-r" option',
+            'The "test-suite" session must be run without the "-r" option',
         )
 
-    session.notify('format')
-    session.notify('lint')
-    session.notify('safety')
-    session.notify('docs')
-
     # Little hack to not work with the extra arguments provided
     # by the pre-commit framework. Create a flag in the
     # env(ironment) that must contain only `str`-like objects.