Switch to ruff for lint and format (#1559)

* add ruff

* fix ruff command

* use ruff action

* update lint action

* update rules

.github/workflows/linter.yml

@@ -10,29 +10,24 @@ on:
 permissions: { }
 
 jobs:
-  build:
+  lint:
     name: Lint Code Base
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: read
-      statuses: write
 
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
+
+      - name: Ruff check
+        uses: chartboost/ruff-action@v1
         with:
-          fetch-depth: 0
+          version: 0.6.7
+          args: "check"
+          changed-files: "true"
 
-      - name: Lint Code Base
-        uses: super-linter/super-linter/slim@v6
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          VALIDATE_ALL_CODEBASE: false
-          VALIDATE_PYTHON_BLACK: true
-          VALIDATE_PYTHON_FLAKE8: true
-          VALIDATE_PYTHON_ISORT: true
-          LINTER_RULES_PATH: /
-          PYTHON_BLACK_CONFIG_FILE: "pyproject.toml"
-          PYTHON_FLAKE8_CONFIG_FILE: ".flake8"
-          PYTHON_ISORT_CONFIG_FILE: "pyproject.toml"
+      - name: Ruff format
+        uses: chartboost/ruff-action@v1
+        with:
+          version: 0.6.7
+          args: "format"
+          changed-files: "true"

.pre-commit-config.yaml

@@ -16,21 +16,9 @@ repos:
       - id: check-yaml
       - id: check-toml
 
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.13.2
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.7
     hooks:
-      - id: isort
-        additional_dependencies: ["isort[pyproject]"]
-
-  - repo: https://github.com/psf/black
-    rev: 24.4.2
-    hooks:
-      - id: black
-        args: ["--config=pyproject.toml"]
-
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.0
-    hooks:
-      - id: flake8
-        args: ["--config=.flake8"]
-        additional_dependencies: [flake8-isort]
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format

.vscode/extensions.json

@@ -3,6 +3,6 @@
     "boto3typed.boto3-ide",
     "ms-python.python",
     "ms-python.vscode-pylance",
-    "ms-python.isort"
+    "charliermarsh.ruff"
   ]
 }

.vscode/settings.json

@@ -3,10 +3,12 @@
     "editor.formatOnSave": false
   },
   "[python]": {
+    "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
+      "source.fixAll": "explicit",
       "source.organizeImports": "explicit"
     },
-    "editor.formatOnSave": true
+    "editor.defaultFormatter": "charliermarsh.ruff"
   },
   "files.associations": {
     "*.envrc": "shellscript",
@@ -19,10 +21,5 @@
   "files.trimFinalNewlines": true,
   "files.trimTrailingWhitespace": true,
   "githubPullRequests.ignoredPullRequestBranches": ["develop", "staging"],
-  "python.formatting.blackPath": "${workspaceFolder}/.venv/bin/black",
-  "python.formatting.provider": "black",
-  "python.languageServer": "Pylance",
-  "python.linting.flake8Args": ["--config=.flake8"],
-  "python.linting.flake8Path": "${workspaceFolder}/.venv/bin/flake8",
-  "isort.args": ["--profile", "black"]
+  "python.languageServer": "Pylance"
 }

Makefile

@@ -52,5 +52,17 @@ reset_db:
 	docker compose exec backend bash -c "python manage.py reset_db --noinput"
 	docker compose exec backend bash -c "python manage.py migrate"
 
+ruff-all:
+	ruff check .
+
+ruff:
+	ruff check --fix $(shell git diff --name-only --staged | grep -E '\.py$$|\/pyproject.toml$$')
+
+ruff-all-docker:
+	docker exec care bash -c "ruff check ."
+
+ruff-docker:
+	docker exec care bash -c "ruff check --fix $(shell git diff --name-only --staged | grep -E '\.py$$|\/pyproject.toml$$')"
+
 %:
 	docker compose exec backend bash -c "python manage.py $*"

Pipfile

@@ -63,6 +63,7 @@ requests-mock = "==1.12.1"
 tblib = "==3.0.0"
 watchdog = "==5.0.2"
 werkzeug = "==3.0.4"
+ruff = "==0.6.7"
 
 [docs]
 furo = "==2024.8.6"