Move to ruff for linting

Author: ChrisLovering

.github/workflows/lint.yml

@@ -17,14 +17,9 @@ jobs:
         with:
           python_version: '3.11'
 
-      # Run flake8 and have it format the linting errors in the format of
-      # the GitHub Workflow command to register error annotations. This
-      # means that our flake8 output is automatically added as an error
-      # annotation to both the run result and in the "Files" tab of a
-      # pull request.
-      #
-      # Format used:
-      # ::error file={filename},line={line},col={col}::{message}
-      - name: Run flake8
-        run: "flake8 \
-          --format='::error file=%(path)s,line=%(row)d,col=%(col)d::[flake8] %(code)s: %(text)s'"
+      - name: Run pre-commit hooks
+        run: SKIP=ruff pre-commit run --all-files
+  
+      # Run `ruff` using github formatting to enable automatic inline annotations.
+      - name: Run ruff
+        run: "ruff check --format=github ."

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+
+  - repo: local
+    hooks:
+      - id: ruff
+        name: ruff
+        description: Run ruff linting
+        entry: poetry run ruff check --force-exclude
+        language: system
+        'types_or': [python, pyi]
+        require_serial: true
+        args: [--fix, --exit-non-zero-on-fix]

pyproject.toml

@@ -30,14 +30,29 @@ python-dotenv = "1.0.0"
 loguru = "0.7.2"
 
 [tool.poetry.dev-dependencies]
-flake8 = "^3.9.0"
-flake8-annotations = "^2.6.2"
-flake8-docstrings = "^1.6.0"
-flake8-import-order = "^0.18.1"
+pre-commit = "3.4.0"
+ruff = "0.0.288"
 
 [tool.poetry.scripts]
 olli = "olli.__main__:start"
 
+[tool.ruff]
+target-version = "py311"
+extend-exclude = [".cache"]
+ignore = [
+    "ANN002", "ANN003", "ANN101", "ANN102",
+    "ARG003",
+    "C901",
+    "D100", "D104", "D105", "D107", "D203", "D212", "D214", "D215", "D416",
+]
+line-length = 120
+select = ["ALL"]
+
+[tool.ruff.isort]
+order-by-type = false
+case-sensitive = true
+combine-as-imports = true
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"