Integrate Ruff code formatter

Author: mkrnr

.github/workflows/ci.yml

@@ -195,6 +195,34 @@ jobs:
       release_skip_job: ${{ steps.set_ouputs.outputs.release_skip_job }}
   # }}}
 
+  # Job: Code Quality {{{
+  code_quality:
+
+    name: Code Quality
+    runs-on: ubuntu-latest
+    needs: [analyze]
+    if: >-
+      !cancelled()
+      && (needs.analyze.result == 'success' || needs.analyze.result == 'skipped')
+
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.13.3
+
+      - name: Install dependencies
+        run: |
+          run "$python" -m pip install -c reqs/constraints.txt -r reqs/code_quality.txt
+
+      - name: Run Ruff (format check)
+        run: ruff format --check .
+  # }}}
+
   # Job: Test (Linux) {{{
   test_linux:
 

.github/workflows/ci/workflow_template.yml

@@ -72,6 +72,34 @@ jobs:
       release_skip_job: ${{ steps.set_ouputs.outputs.release_skip_job }}
   # }}}
 
+  # Job: Code Quality {{{
+  code_quality:
+
+    name: Code Quality
+    runs-on: ubuntu-latest
+    needs: [analyze]
+    if: >-
+      !cancelled()
+      && (needs.analyze.result == 'success' || needs.analyze.result == 'skipped')
+
+    steps:
+
+      - name: Checkout
+        uses: <@ action_checkout @>
+
+      - name: Setup Python
+        uses: <@ action_setup_python @>
+        with:
+          python-version: <@ default_python @>
+
+      - name: Install dependencies
+        run: |
+          run "$python" -m pip install -c reqs/constraints.txt -r reqs/code_quality.txt
+
+      - name: Run Ruff (format check)
+        run: ruff format --check .
+  # }}}
+
   <% for j in jobs %>
   # Job: <@ j.name @> {{{
   <@ j.id @>:

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+- repo: local
+  hooks:
+    - id: ruff-format
+      name: ruff format
+      entry: ruff format
+      language: system
+      types: [python]

reqs/code_quality.txt

@@ -0,0 +1 @@
+ruff

reqs/constraints.txt

@@ -35,6 +35,7 @@ pkginfo==1.12.1.2
 plover-stroke==1.1.0
 pluggy==1.5.0
 plyer==2.1.0
+pre-commit==4.2.0
 psutil==7.0.0
 py==1.11.0
 pycparser==2.22
@@ -57,12 +58,14 @@ requests-futures==1.0.2
 requests-toolbelt==1.0.0
 rfc3986==2.0.0
 rtf-tokenize==1.0.0
+ruff==0.12.0
 SecretStorage==3.3.3
 setuptools==79.0.0
 six==1.17.0
 toml==0.10.2
 tomli==2.2.1
 towncrier==24.8.0
+tox==4.27.0
 tqdm==4.67.1
 twine==6.1.0
 url-normalize==2.2.0

reqs/dev.txt

@@ -0,0 +1,4 @@
+-r ci.txt
+-r code_quality.txt
+pre-commit
+tox