MAINT: Black, ruff, pre-commit

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# black
+7d03ec2f7bb5d12a747366cecd7e56b306a35d7f

.github/workflows/run-tests.yml

@@ -15,10 +15,11 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - uses: actions/setup-python@v4
-    - name: Install flake8 and codespell
-      run: pip install flake8 flake8-pyproject codespell tomli
-    - run: make flake
+    - name: Install ruff and codespell
+      run: pip install ruff codespell tomli
+    - run: make ruff
     - run: make codespell-error
+    - uses: psf/black@stable
   check-doc:
     name: Doc consistency
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+---
+# Eventually we should use yamllint, too
+files: ^(.*\.(py|yaml))$
+exclude: ^(\.[^/]*cache/.*)$
+repos:
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+        args:
+          - --safe
+          - --quiet
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.178
+    hooks:
+      - id: ruff
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.2
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli

Makefile

@@ -33,9 +33,9 @@ check:
 trailing-spaces:
 	find . -name "*.py" | xargs perl -pi -e 's/[ \t]*$$//'
 
-flake:
-	flake8
-	@echo "flake8 passed"
+ruff:
+	ruff .
+	@echo "ruff passed"
 
 codespell:  # running manually; auto-fix spelling mistakes
 	@codespell --write-changes $(CODESPELL_DIRS)

docs/hooks.py

@@ -3,7 +3,7 @@
 
 from mkdocs.config.defaults import MkDocsConfig
 
-logger = logging.getLogger('mkdocs')
+logger = logging.getLogger("mkdocs")
 
 config_updated = False
 
@@ -19,6 +19,6 @@ def on_template_context(
     global config_updated
     if not config_updated:
         config_updated = True
-        now = context['build_date_utc'].strftime('%Y/%m/%d')
-        config.copyright = f'{config.copyright}, last updated {now}'
-        logger.info(f'Updated copyright to {config.copyright}')
+        now = context["build_date_utc"].strftime("%Y/%m/%d")
+        config.copyright = f"{config.copyright}, last updated {now}"
+        logger.info(f"Updated copyright to {config.copyright}")

docs/main.py

@@ -2,11 +2,12 @@
 This file contains hooks to simplify changelog generation.
 """
 
+
 def define_env(env):
-  'Hook function'
+    "Hook function"
 
-  @env.macro
-  def gh(pr_id):
-      url = f'https://github.com/mne-tools/mne-bids-pipeline/pull/{pr_id}'
-      markdown = f'[#{pr_id}]({url})'
-      return markdown
+    @env.macro
+    def gh(pr_id):
+        url = f"https://github.com/mne-tools/mne-bids-pipeline/pull/{pr_id}"
+        markdown = f"[#{pr_id}]({url})"
+        return markdown

docs/source/doc-config.py

@@ -1,2 +1,2 @@
-bids_root = '/tmp'
-ch_types = ['meg']
+bids_root = "/tmp"
+ch_types = ["meg"]