dep: add pre-commit to dev dependencies

Author: nicklafleur

.pre-commit-config.yaml

@@ -19,6 +19,4 @@ repos:
     hooks:
     -   id: ruff
         args: [--fix, --exit-non-zero-on-fix]
-        exclude: ^(docs/_themes/|docs/conf\.py|e2e_projects/|tests/data/test_generation/)
     -   id: ruff-format
-        exclude: ^(docs/_themes/|docs/conf\.py|e2e_projects/|tests/data/test_generation/)

CONTRIBUTING.rst

@@ -46,6 +46,14 @@ Codebases using Poetry
     # Install dependencies in your Poetry environment
     pip install -r <path_to_mutmut_codebase>/requirements.txt
 
+
+Linting and Formatting
+^^^^^^^^^^^^^^^^^^^^^^
+
+This project primarily uses `ruff` for linting and formatting through `pre-commit`. You can run the linting and formatting locally with `uv run pre-commit run --all-files`.
+
+Additionally (and recommended), you can run `pre-commit install` to install the pre-commit hooks to run automatically when running `git commit`.
+
 Documentation about mutmut's architecture
 -----------------------------------------
 

e2e_projects/config/README.md

@@ -1 +1 @@
-This project uses most/all of the mutmut configuration in pyproject.toml.
+This project uses most/all of the mutmut configuration in pyproject.toml.

e2e_projects/config/config_pkg/ignore_me.py

@@ -1,2 +1,2 @@
 def this_function_shall_NOT_be_mutated():
-    return 1 + 2
+    return 1 + 2

e2e_projects/config/data/data.json

@@ -1,3 +1,3 @@
 {
     "comment": "this should be copied to the mutants folder"
-}
+}

e2e_projects/config/tests/main/test_main.py

@@ -26,7 +26,7 @@ def test_include_data_exists():
         data = json.load(f)
         assert data['comment'] == 'this should be copied to the mutants folder'
 
-# ignored, because it does not match -k 'test_include' 
+# ignored, because it does not match -k 'test_include'
 def test_should_be_ignored():
     assert 'This test should be ignored' == 1234
 
@@ -38,4 +38,4 @@ def test_include_xfail_that_does_not_fail():
 # ignored, because of -m 'not fail'
 @pytest.mark.fail
 def test_include_that_should_be_ignored():
-    assert 'This test should be ignored' == 1234
+    assert 'This test should be ignored' == 1234

e2e_projects/mutate_only_covered_lines/src/mutate_only_covered_lines/__init__.py

@@ -40,4 +40,3 @@ def mutate_only_covered_lines_multiline(simple_branch: bool) -> str:
         ]
         return f"Hello from mutate_only_covered_lines!" \
             f" (false) {x} {y}"
-

e2e_projects/mutate_only_covered_lines/src/mutate_only_covered_lines/ignore_me.py

@@ -1,2 +1,2 @@
 def this_function_shall_NOT_be_mutated():
-    return 1 + 2
+    return 1 + 2

e2e_projects/mutate_only_covered_lines/tests/main/test_mutate_only_covered_lines.py

@@ -13,4 +13,4 @@ def test_mutate_only_covered_lines_multiline():
     assert mutate_only_covered_lines_multiline(True) == "Hello from mutate_only_covered_lines! (true) FooBar [0, 4, 8, 12, 16]"
 
 def call_ignored_function():
-    assert this_function_shall_NOT_be_mutated() == 3
+    assert this_function_shall_NOT_be_mutated() == 3

e2e_projects/my_lib/README.md

@@ -1 +1 @@
-This project will be E2E tested. It mainly serves as a "canary" that alerts you when code changes affect which mutants survive.
+This project will be E2E tested. It mainly serves as a "canary" that alerts you when code changes affect which mutants survive.