add linter (#15)

* add lint

* move typing comment

* add numpydoc

* Update .pre-commit-config.yaml

Co-authored-by: Pavel Zwerschke <[email protected]>

* fixes

---------

Co-authored-by: Lucas Colley <[email protected]>
Co-authored-by: Pavel Zwerschke <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ env:
 
 jobs:
   lint:
-    name: Format
+    name: Lint
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

.pre-commit-config.yaml

@@ -0,0 +1,59 @@
+repos:
+- repo: local
+  hooks:
+    # ensure pixi environments are up to date
+    # workaround for https://github.com/prefix-dev/pixi/issues/1482
+  - id: pixi-install
+    name: Update pixi lint environment
+    entry: pixi install -e default -e lint
+    pass_filenames: false
+    language: system
+    always_run: true
+    require_serial: true
+
+  # pre-commit-hooks
+  - id: trailing-whitespace-fixer
+    name: Fix trailing whitespace with pre-commit-hooks
+    entry: pixi run -e lint trailing-whitespace-fixer
+    language: system
+    types: [text]
+
+  # pre-commit-hooks
+  - id: end-of-file-fixer
+    name: Fix end-of-file with pre-commit-hooks
+    entry: pixi run -e lint end-of-file-fixer
+    language: system
+    types: [text]
+
+  - id: ruff check
+    name: Lint with ruff
+    entry: pixi run -e lint ruff check --force-exclude --fix
+    language: system
+    types_or: [python, pyi, jupyter]
+    require_serial: true
+
+  - id: ruff format
+    name: Format with ruff
+    entry: pixi run -e lint ruff format --force-exclude
+    language: system
+    types_or: [python, pyi, jupyter]
+    require_serial: true
+
+  - id: mdformat
+    name: Format markdown with mdformat
+    entry: pixi run -e lint mdformat
+    language: system
+    types: [markdown]
+
+  - id: taplo
+    name: Format TOML with taplo
+    entry: pixi run -e lint taplo fmt
+    language: system
+    types: [toml]
+
+  - id: numpydoc-validation
+    name: numpydoc-validation
+    entry: pixi run -e lint numpydoc lint
+    require_serial: false
+    language: system
+    types: [python]