feat: add pre commit

.gitattributes

@@ -1,3 +1,2 @@
 # GitHub syntax highlighting
 pixi.lock linguist-language=YAML
-

.github/workflows/run_tests.yml

@@ -1,10 +1,10 @@
-# name: Run tests for parselmouth
+# name: Run tests, pre-commit stuff and type checking for parselmouth
 
 on:
-    push:
-    workflow_dispatch:
-    pull_request:
-  
+  push:
+    branches: [ "main" ]
+  pull_request:
+
 jobs:
   run_tests:
     runs-on: ubuntu-latest
@@ -22,6 +22,22 @@ jobs:
             manifest-path: pyproject.toml
 
         - name: run tests
-          run: | 
+          run: |
            pixi run run_tests
-
+
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up pixi
+        uses: prefix-dev/[email protected]
+        with:
+          environments: >-
+            fmt
+            type-checking
+
+      - name: pre-commit
+        run: pixi run pre-commit-run --color=always --show-diff-on-failure --all
+
+      - name: type check
+        run: pixi run type-check

.github/workflows/updater.yml

@@ -29,7 +29,7 @@ jobs:
 
 
         - name: pixi install
-          run: | 
+          run: |
            pixi install
 
         - name: Generate combination of missing subdirs and letters
@@ -45,7 +45,7 @@ jobs:
             R2_PREFIX_ACCESS_KEY_ID: ${{ secrets.R2_PREFIX_ACCESS_KEY_ID }}
             R2_PREFIX_SECRET_ACCESS_KEY: ${{ secrets.R2_PREFIX_SECRET_ACCESS_KEY }}
             R2_PREFIX_BUCKET: ${{ secrets.R2_PREFIX_BUCKET }}
-        
+
         - name: Upload requested index.json
           uses: actions/upload-artifact@v4
           with:
@@ -74,9 +74,9 @@ jobs:
           manifest-path: pyproject.toml
 
       - name: pixi install
-        run: | 
+        run: |
           pixi install
-    
+
       - name: Get partial index artifacts
         uses: actions/download-artifact@v4
         with:
@@ -90,16 +90,16 @@ jobs:
             R2_PREFIX_ACCESS_KEY_ID: ${{ secrets.R2_PREFIX_ACCESS_KEY_ID }}
             R2_PREFIX_SECRET_ACCESS_KEY: ${{ secrets.R2_PREFIX_SECRET_ACCESS_KEY }}
             R2_PREFIX_BUCKET: ${{ secrets.R2_PREFIX_BUCKET }}
-        
+
       - name: Upload partial index
         uses: actions/upload-artifact@v4
         with:
             name: partial_index_${{ matrix.subdirs }}
             path: output
-    
+
   updater_of_index:
     runs-on: ubuntu-latest
-    needs: updater_of_records  
+    needs: updater_of_records
     steps:
         - uses: actions/checkout@v4
 
@@ -111,9 +111,9 @@ jobs:
           with:
             pixi-version: "latest"
             manifest-path: pyproject.toml
-    
+
         - name: pixi install
-          run: | 
+          run: |
             pixi install
 
         - name: Get partial index artifacts
@@ -129,7 +129,7 @@ jobs:
             R2_PREFIX_ACCESS_KEY_ID: ${{ secrets.R2_PREFIX_ACCESS_KEY_ID }}
             R2_PREFIX_SECRET_ACCESS_KEY: ${{ secrets.R2_PREFIX_SECRET_ACCESS_KEY }}
             R2_PREFIX_BUCKET: ${{ secrets.R2_PREFIX_BUCKET }}
-  
+
   update_file:
     runs-on: ubuntu-latest
     permissions:
@@ -139,7 +139,7 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-      
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
@@ -169,4 +169,4 @@ jobs:
           git add files/mapping_as_grayskull.json
           git add files/compressed_mapping.json
           git commit -m "Update file via GitHub Action" || true
-          git push
+          git push

.gitignore

@@ -152,6 +152,12 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+# DS_Store files
+.DS_Store
+
+# Vs code
+.vscode/
+
 # PyCharm
 #  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
@@ -163,4 +169,3 @@ mapping/*# pixi environments
 .pixi
 # pixi environments
 .pixi
-

.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+exclude: (^.pixi/|.snap|^files/)
+repos:
+  - repo: local
+    hooks:
+      - id: pixi-install
+        name: pixi-install
+        entry: pixi install -e fmt
+        language: system
+        always_run: true
+        require_serial: true
+        pass_filenames: false
+      # pre-commit-hooks
+      - id: check-yaml
+        name: check-yaml
+        entry: pixi run -e fmt check-yaml
+        language: system
+        types: [yaml]
+      - id: end-of-file
+        name: end-of-file
+        entry: pixi run -e fmt end-of-file-fixer
+        language: system
+        types: [text]
+        stages: [commit, push, manual]
+      - id: trailing-whitespace
+        name: trailing-whitespace
+        entry: pixi run -e fmt trailing-whitespace-fixer
+        language: system
+        types: [text]
+        stages: [commit, push, manual]
+      # Use ruff for python examples
+      - id: ruff
+        name: ruff
+        entry: pixi run -e fmt ruff check --fix --exit-non-zero-on-fix --force-exclude
+        language: system
+        types_or: [python, pyi]
+        require_serial: true
+      - id: ruff-format
+        name: ruff-format
+        entry: pixi run -e fmt ruff format --force-exclude
+        language: system
+        types_or: [python, pyi]
+        require_serial: true
+      # typos
+      - id: typos
+        name: typos
+        entry: pixi run -e fmt typos --write-changes --force-exclude
+        language: system
+        types: [text]

CODE_OF_CONDUCT.md

@@ -125,4 +125,4 @@ enforcement ladder](https://github.com/mozilla/diversity).
 
 For answers to common questions about this code of conduct, see the FAQ at
 https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+https://www.contributor-covenant.org/translations.

README.md

@@ -47,4 +47,3 @@ More simplified version of our mapping is stored here: `files/mapping_as_graysku
 
 
 Developed with ❤️ at [prefix.dev](https://prefix.dev).
-