DX!: switch to Ruff as linter (#28)

* MAINT: apply Ruff autofixes
* MAINT: autoupdate pre-commit hooks
* MAINT: implement updates from pre-commit hooks
* MAINT: remove pylint ignore comments

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: GitHub <[email protected]>
Co-authored-by: Remco de Boer <[email protected]>

.cspell.json

@@ -24,14 +24,11 @@
     "*particle*.*ml",
     ".constraints/*.txt",
     ".editorconfig",
-    ".flake8*",
     ".gitignore",
     ".gitpod.*",
     ".mypy.ini",
     ".pre-commit-config.yaml",
     ".prettierignore",
-    ".pydocstyle*",
-    ".pylintrc",
     ".readthedocs.yml",
     ".vscode/*",
     ".vscode/.gitignore",
@@ -55,7 +52,7 @@
     "typings"
   ],
   "language": "en-US",
-  "words": ["ComPWA", "conda", "doctests", "pdgref", "pylint", "pytest"],
+  "words": ["ComPWA", "conda", "doctests", "pdgref", "pytest"],
   "ignoreWords": [
     "MAINT",
     "PYTHONHASHSEED",

.github/workflows/ci.yml

@@ -30,7 +30,7 @@ jobs:
     uses: ComPWA/actions/.github/workflows/pytest.yml@v1
     with:
       coverage-target: sphinxcontrib
-      macos-python-version: "3.7"
+      macos-python-version: "3.9"
       specific-pip-packages: ${{ inputs.specific-pip-packages }}
   style:
     if: inputs.specific-pip-packages == ''

.gitpod.yml

@@ -13,15 +13,15 @@ github:
 
 vscode:
   extensions:
+    - charliermarsh.ruff
     - christian-kohler.path-intellisense
     - davidanson.vscode-markdownlint
     - eamodio.gitlens
     - editorconfig.editorconfig
     - esbenp.prettier-vscode
+    - garaioag.garaio-vscode-unwanted-recommendations
     - github.vscode-github-actions
-    - ms-python.flake8
-    - ms-python.isort
-    - ms-python.pylint
+    - ms-python.mypy-type-checker
     - ms-python.python
     - ms-python.vscode-pylance
     - redhat.vscode-yaml

.pre-commit-config.yaml

@@ -2,9 +2,7 @@ ci:
   autoupdate_commit_msg: "MAINT: autoupdate pre-commit hooks"
   autoupdate_schedule: quarterly # already done by requirements-cron.yml
   skip:
-    - flake8
     - mypy
-    - pylint
     - pyright
     - taplo
 
@@ -43,7 +41,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/ComPWA/repo-maintenance
-    rev: 0.0.179
+    rev: 0.0.192
     hooks:
       - id: check-dev-files
         args:
@@ -57,7 +55,7 @@ repos:
       - id: black
 
   - repo: https://github.com/asottile/blacken-docs
-    rev: 1.13.0
+    rev: 1.15.0
     hooks:
       - id: blacken-docs
 
@@ -67,7 +65,7 @@ repos:
       - id: cspell
 
   - repo: https://github.com/editorconfig-checker/editorconfig-checker.python
-    rev: 2.7.1
+    rev: 2.7.2
     hooks:
       - id: editorconfig-checker
         name: editorconfig
@@ -77,22 +75,8 @@ repos:
             .*\.py
           )$
 
-  - repo: local
-    hooks:
-      - id: flake8
-        name: flake8
-        entry: flake8
-        language: system
-        types:
-          - python
-
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.33.0
+    rev: v0.35.0
     hooks:
       - id: markdownlint
 
@@ -106,39 +90,29 @@ repos:
           - python
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.0-alpha.6
+    rev: v3.0.0
     hooks:
       - id: prettier
 
-  - repo: https://github.com/pycqa/pydocstyle
-    rev: 6.3.0
-    hooks:
-      - id: pydocstyle
-
-  - repo: local
-    hooks:
-      - id: pylint
-        name: pylint
-        entry: pylint
-        args:
-          - --rcfile=.pylintrc
-          - --score=no
-        language: system
-        types:
-          - python
-
   - repo: https://github.com/ComPWA/mirrors-pyright
-    rev: v1.1.303
+    rev: v1.1.316
     hooks:
       - id: pyright
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
+    rev: v3.9.0
     hooks:
       - id: pyupgrade
         args:
           - --py36-plus
 
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.277
+    hooks:
+      - id: ruff
+        args:
+          - --fix
+
   - repo: https://github.com/ComPWA/mirrors-taplo
     rev: v0.8.0
     hooks:

.vscode/extensions.json

@@ -1,14 +1,14 @@
 {
   "recommendations": [
+    "charliermarsh.ruff",
     "christian-kohler.path-intellisense",
     "davidanson.vscode-markdownlint",
     "eamodio.gitlens",
     "editorconfig.editorconfig",
     "esbenp.prettier-vscode",
+    "garaioag.garaio-vscode-unwanted-recommendations",
     "github.vscode-github-actions",
-    "ms-python.flake8",
-    "ms-python.isort",
-    "ms-python.pylint",
+    "ms-python.mypy-type-checker",
     "ms-python.python",
     "ms-python.vscode-pylance",
     "redhat.vscode-yaml",
@@ -18,5 +18,12 @@
     "tamasfe.even-better-toml",
     "tyriar.sort-lines",
     "yzhang.markdown-all-in-one"
+  ],
+  "unwantedRecommendations": [
+    "bungcip.better-toml",
+    "ms-python.flake8",
+    "ms-python.isort",
+    "ms-python.pylint",
+    "travisillig.vscode-json-stable-stringify"
   ]
 }

.vscode/settings.json

@@ -23,11 +23,11 @@
   "[yaml]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
-  "cSpell.enabled": true,
   "coverage-gutters.coverageFileNames": ["coverage.xml"],
   "coverage-gutters.coverageReportFileName": "**/htmlcov/index.html",
   "coverage-gutters.showGutterCoverage": false,
   "coverage-gutters.showLineCoverage": true,
+  "cSpell.enabled": true,
   "editor.formatOnSave": true,
   "editor.rulers": [88],
   "files.watcherExclude": {
@@ -36,29 +36,28 @@
     "**/.git/**": true,
     "**/.tox/**": true
   },
-  "flake8.importStrategy": "fromEnvironment",
   "git.rebaseWhenSync": true,
   "github-actions.workflows.pinned.refresh.enabled": true,
   "github-actions.workflows.pinned.workflows": [".github/workflows/ci.yml"],
-  "isort.check": true,
-  "isort.importStrategy": "fromEnvironment",
-  "pylint.importStrategy": "fromEnvironment",
+  "mypy-type-checker.args": ["--config-file", "pyproject.toml"],
+  "mypy-type-checker.importStrategy": "fromEnvironment",
   "python.analysis.autoImportCompletions": false,
-  "python.analysis.diagnosticMode": "workspace",
   "python.analysis.inlayHints.pytestParameters": true,
   "python.analysis.typeCheckingMode": "strict",
   "python.formatting.provider": "black",
   "python.linting.banditEnabled": false,
   "python.linting.enabled": true,
   "python.linting.flake8Enabled": false,
-  "python.linting.mypyEnabled": true,
-  "python.linting.pydocstyleEnabled": true,
+  "python.linting.mypyEnabled": false,
+  "python.linting.pydocstyleEnabled": false,
   "python.linting.pylamaEnabled": false,
   "python.linting.pylintEnabled": false,
   "python.testing.pytestArgs": ["--color=no", "--no-cov"],
   "python.testing.pytestEnabled": true,
   "python.testing.unittestEnabled": false,
   "rewrap.wrappingColumn": 88,
+  "ruff.enable": true,
+  "ruff.organizeImports": true,
   "search.exclude": {
     "**/tests/**/__init__.py": true,
     "*/.pydocstyle": true,

README.md

@@ -13,7 +13,7 @@
 [![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 This package is a
 [Sphinx extension](https://www.sphinx-doc.org/en/master/usage/extensions/index.html)