Merge pull request #656 from fizyk/pre-commit

Use pre-commit, drop old linters workflow (and add rstcheck) - closes…

Author: fizyk

.coveragerc

@@ -2,4 +2,4 @@
 include =
     matchbox/*
     tests/*
-    benchmarks/*
+    benchmarks/*

.github/workflows/automerge.yml

@@ -16,4 +16,3 @@ jobs:
     secrets:
       app_id: ${{ secrets.MERGE_APP_ID }}
       private_key: ${{ secrets.MERGE_APP_PRIVATE_KEY }}
-

.github/workflows/build.yml

@@ -8,4 +8,4 @@ on:
 
 jobs:
   build:
-    uses: fizyk/actions-reuse/.github/workflows/shared-pypi.yml@v3.0.2
+    uses: fizyk/actions-reuse/.github/workflows/shared-pypi.yml@v3.0.2

.github/workflows/linters.yml

@@ -6,4 +6,4 @@ on:
 
 jobs:
   pr-check:
-    uses: fizyk/actions-reuse/.github/workflows/shared-pr-check.yml@v3.0.2
+    uses: fizyk/actions-reuse/.github/workflows/shared-pr-check.yml@v3.0.2

.github/workflows/pr-check.yml

@@ -0,0 +1,12 @@
+name: Run linters
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+
+jobs:
+  pre-commit:
+    uses: fizyk/actions-reuse/.github/workflows/shared-pre-commit.yml@v3.0.1

.github/workflows/pre-commit.yml

@@ -9,4 +9,4 @@ jobs:
     with:
       publish: true
     secrets:
-      pypi_token: ${{ secrets.pypi_token }}
+      pypi_token: ${{ secrets.pypi_token }}

.github/workflows/pypi.yml

@@ -25,4 +25,4 @@ jobs:
           publish_dir: build/html/
           destination_dir: docs/
           enable_jekyll: false
-          keep_files: false
+          keep_files: false

.github/workflows/sphinx-docs.yml

@@ -0,0 +1,62 @@
+---
+ci:
+  skip: [pipenv, mypy]
+
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+minimum_pre_commit_version: 4.0.0
+default_stages: [pre-commit]
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: trailing-whitespace
+      - id: check-toml
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: check-yaml
+      - id: pretty-format-json
+      - id: detect-private-key
+      - id: debug-statements
+
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+        entry: black --config pyproject.toml .
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.6
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix, --respect-gitignore, --show-fixes]
+
+  - repo: https://github.com/rstcheck/rstcheck
+    rev: v6.2.4
+    hooks:
+      - id: rstcheck
+        additional_dependencies: [sphinx, toml]
+
+  - repo: local
+    hooks:
+      - id: pipenv
+        stages: [pre-commit, manual]
+        language: system
+        name: Install dependencies for the local linters
+        entry: bash -c "pip install pipenv && pipenv install --dev"
+        types_or:
+          - python
+          - toml  # Pipfile
+        pass_filenames: false
+      - id: mypy
+        stages: [pre-commit, manual]
+        name: mypy
+        entry: pipenv run mypy .
+        language: system
+        types_or:
+          - python
+          - toml  # Pipfile
+        pass_filenames: false

.pre-commit-config.yaml

@@ -0,0 +1,4 @@
+[rstcheck]
+report_level = warning
+ignore_directives =
+    automodule