Sourcery as a pre-commit hook

Author: DimitriPapadopoulos

.pre-commit-config.yaml

@@ -1,58 +1,66 @@
 ci:
-  autoupdate_commit_msg: "chore: update pre-commit hooks"
-  autoupdate_schedule: "monthly"
-  autofix_commit_msg: "style: pre-commit fixes"
+  autoupdate_commit_msg: 'chore: update pre-commit hooks'
+  autoupdate_schedule: monthly
+  autofix_commit_msg: 'style: pre-commit fixes'
   autofix_prs: false
 default_stages: [pre-commit, pre-push]
 repos:
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.9
-    hooks:
-      - id: ruff
-        args: ["--fix", "--show-fixes"]
-      - id: ruff-format
-  - repo: https://github.com/codespell-project/codespell
-    rev: v2.4.1
-    hooks:
-      - id: codespell
-        args: ["-L", "fo,ihs,kake,te", "-S", "fixture"]
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
-    hooks:
-      - id: check-yaml
-      - id: trailing-whitespace
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.15.0
-    hooks:
-      - id: mypy
-        files: src|tests
-        additional_dependencies:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.11.9
+  hooks:
+  - id: ruff
+    args: [--fix, --show-fixes]
+  - id: ruff-format
+- repo: https://github.com/sourcery-ai/sourcery
+  rev: v1.37.0
+  hooks:
+  - id: sourcery
+    # The best way to use Sourcery in a pre-commit hook:
+    # * review only changed lines:
+    # * omit the summary
+    args: [--diff=git diff HEAD, --no-summary]
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.4.1
+  hooks:
+  - id: codespell
+    args: [-L, 'fo,ihs,kake,te', -S, fixture]
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+  - id: check-yaml
+  - id: trailing-whitespace
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.15.0
+  hooks:
+  - id: mypy
+    files: src|tests
+    additional_dependencies:
           # Package dependencies
-          - packaging
-          - donfig
-          - numcodecs[crc32c]
-          - numpy==2.1 # until https://github.com/numpy/numpy/issues/28034 is resolved
-          - typing_extensions
-          - universal-pathlib
-          - obstore>=0.5.1
+    - packaging
+    - donfig
+    - numcodecs[crc32c]
+    - numpy==2.1       # until https://github.com/numpy/numpy/issues/28034 is resolved
+    - typing_extensions
+    - universal-pathlib
+    - obstore>=0.5.1
           # Tests
-          - pytest
-          - hypothesis
-          - s3fs
-  - repo: https://github.com/scientific-python/cookie
-    rev: 2025.05.02
-    hooks:
-      - id: sp-repo-review
-  - repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.10.0
-    hooks:
-      - id: rst-directive-colons
-      - id: rst-inline-touching-normal
-  - repo: https://github.com/numpy/numpydoc
-    rev: v1.8.0
-    hooks:
-      - id: numpydoc-validation
-  - repo: https://github.com/twisted/towncrier
-    rev: 24.8.0
-    hooks:
-      - id: towncrier-check
+    - pytest
+    - hypothesis
+    - s3fs
+- repo: https://github.com/scientific-python/cookie
+  rev: 2025.05.02
+  hooks:
+  - id: sp-repo-review
+- repo: https://github.com/pre-commit/pygrep-hooks
+  rev: v1.10.0
+  hooks:
+  - id: rst-directive-colons
+  - id: rst-inline-touching-normal
+- repo: https://github.com/numpy/numpydoc
+  rev: v1.8.0
+  hooks:
+  - id: numpydoc-validation
+- repo: https://github.com/twisted/towncrier
+  rev: 24.8.0
+  hooks:
+  - id: towncrier-check

.sourcery.yaml

@@ -0,0 +1,82 @@
+# 🪄 This is your project's Sourcery configuration file.
+
+# You can use it to get Sourcery working in the way you want, such as
+# ignoring specific refactorings, skipping directories in your project,
+# or writing custom rules.
+
+# 📚 For a complete reference to this file, see the documentation at
+# https://docs.sourcery.ai/Configuration/Project-Settings/
+
+# This file was auto-generated by Sourcery on 2025-06-20 at 14:38.
+
+version: '1'  # The schema version of this config file
+
+ignore: # A list of paths or files which Sourcery will ignore.
+- .git
+- env
+- .env
+- .tox
+- node_modules
+- vendor
+- venv
+- .venv
+- ~/.pyenv
+- ~/.rye
+- ~/.vscode
+- .vscode
+- ~/.cache
+- ~/.config
+- ~/.local
+
+rule_settings:
+  enable:
+  - default
+  disable: []  # A list of rule IDs Sourcery will never suggest.
+  rule_types:
+  - refactoring
+  - suggestion
+  - comment
+  python_version: '3.11' # A string specifying the lowest Python version your project supports. Sourcery will not suggest refactorings requiring a higher Python version.
+
+# rules:  # A list of custom rules Sourcery will include in its analysis.
+# - id: no-print-statements
+#   description: Do not use print statements in the test directory.
+#   pattern: print(...)
+#   language: python
+#   replacement:
+#   condition:
+#   explanation:
+#   paths:
+#     include:
+#     - test
+#     exclude:
+#     - conftest.py
+#   tests: []
+#   tags: []
+
+# rule_tags: {} # Additional rule tags.
+
+# metrics:
+#   quality_threshold: 25.0
+
+# github:
+#   labels: []
+#   ignore_labels:
+#   - sourcery-ignore
+#   request_review: author
+#   sourcery_branch: sourcery/{base_branch}
+
+# clone_detection:
+#   min_lines: 3
+#   min_duplicates: 2
+#   identical_clones_only: false
+
+# proxy:
+#   url:
+#   ssl_certs_file:
+#   no_ssl_verify: false
+
+# coding_assistant:
+#   project_description: ''
+#   enabled: true
+#   recipe_prompts: {}