DX: lint PRs with @compwa/commitlint-config

.github/workflows/pr-linting.yml

@@ -1,5 +1,3 @@
-# cspell:ignore agilepathway commitlint kode
-
 name: PR linting
 on:
   pull_request:
@@ -16,7 +14,7 @@ jobs:
     name: Check labels
     runs-on: ubuntu-20.04
     steps:
-      - uses: docker://agilepathway/pull-request-label-checker:latest
+      - uses: docker://agilepathway/pull-request-label-checker:latest # cspell:ignore agilepathway
         with:
           any_of: >-
             🐛 Bug,✨ Feature,⚙️ Enhancement,⚠️ Interface,❗ Behavior,📝 Docs,🔨 Maintenance,🖱️ DX
@@ -29,4 +27,8 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - run: npm install @commitlint/config-conventional
-      - uses: JulienKode/[email protected]
+      - run: npm install @compwa/commitlint-config
+      - name: Create commitlint config
+        run: |
+          echo "module.exports = {extends: ['@compwa/commitlint-config']}" > commitlint.config.js
+      - uses: JulienKode/[email protected] # cspell:ignore kode

.gitignore

@@ -10,6 +10,7 @@
 *.xml
 *.yaml
 *.yml
+commitlint.config.js
 
 # Build files
 *.egg-info/

.vscode/settings.json

@@ -62,8 +62,7 @@
     "src/repoma/.template/.cspell.json": true,
     "src/repoma/.template/.gitpod.yml": true,
     "src/repoma/.template/.prettierrc": true,
-    "src/repoma/.template/.taplo.toml": true,
-    "src/repoma/.template/commitlint.config.js": true
+    "src/repoma/.template/.taplo.toml": true
   },
   "yaml.schemas": {
     "https://citation-file-format.github.io/1.2.0/schema.json": "CITATION.cff",

src/repoma/check_dev_files/commitlint.py

@@ -1,6 +1,16 @@
-"""Check :file:`commitlint.config.js` config file."""
-from repoma.utilities import CONFIG_PATH, update_file
+"""Remove :file:`commitlint.config.js` config file.
+
+See https://github.com/ComPWA/repo-maintenance/issues/177.
+"""
+import os
+
+from repoma.errors import PrecommitError
 
 
 def main() -> None:
-    update_file(CONFIG_PATH.commitlint, in_template_folder=True)
+    path = "commitlint.config.js"
+    if not os.path.exists(path):
+        return
+    os.remove(path)
+    msg = f"Remove outdated {path}"
+    raise PrecommitError(msg)

src/repoma/utilities/__init__.py

@@ -14,7 +14,6 @@
 class _ConfigFilePaths(NamedTuple):
     citation: Path = Path("CITATION.cff")
     codecov: Path = Path("codecov.yml")
-    commitlint: Path = Path("commitlint.config.js")
     cspell: Path = Path(".cspell.json")
     editorconfig: Path = Path(".editorconfig")
     github_workflow_dir: Path = Path(".github/workflows")