add mypy to ci (but ignore for now), add numpy typing plugin

modflowpy · Sep 3, 2024 · aa4c635 · aa4c635
1 parent d086f1b
commit aa4c635
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -12,8 +12,8 @@ on:
       - '**.md'
       - '.gitignore'
 jobs:
-  lint:
-    name: Lint
+  check:
+    name: Check
     runs-on: ubuntu-latest
     steps:
 
@@ -30,8 +30,15 @@ jobs:
       - name: Install Python packages
         run: pip install ".[lint]"
 
-      - name: Run ruff
+      - name: Linter
         run: ruff check .
+
+      - name: Formatter
+        run: ruff format --check
+
+      # TODO: enable when passing
+      # - name: Type checker
+      #   run: mypy flopy4
 
   build:
     name: Build

diff --git a/pyproject.toml b/pyproject.toml
@@ -105,3 +105,10 @@ ignore = [
     "F821", # undefined name TODO FIXME
     "E722"  # do not use bare `except`
 ]
+
+[tool.mypy]
+packages = ["flopy4"]
+modules = ["test"]
+plugins = [
+    "numpy.typing.mypy_plugin"
+]