Merge pull request #21 from sul-dlss-labs/t18-ruff-check

Check formatting
sul-dlss · Jun 17, 2024 · 9fa6a6e · 9fa6a6e
2 parents b2fcb2a + ca9c77e
commit 9fa6a6e
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -18,9 +18,11 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Lint
+      - name: Lint and format
         uses: chartboost/ruff-action@v1
         # it may move, see https://github.com/astral-sh/ruff/issues/8400
+        with:
+          args: 'format --check'
 
       - name: Install dependencies
         run: |

diff --git a/README.md b/README.md
@@ -94,3 +94,9 @@ Then run the tests:
 ```
 pytest
 ```
+
+### Linting and formatting
+
+1. Run linting: `ruff check`
+2. Automatically fix linting: `ruff check --fix`
+3. Run formatting: `ruff format` (or `ruff format --check` to identify any unformatted files)
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,3 +1,4 @@
 pytest
 python-dotenv
+ruff
 apache-airflow==2.9.2