build: adds linting and static type checking

Author: tdstein

.github/workflows/push.yml

@@ -21,3 +21,4 @@ jobs:
     - run: just deps
     - run: just test
     - run: just cov
+    - run: just lint

.gitignore

@@ -161,3 +161,6 @@ cython_debug/
 
 # Version file
 /src/posit/_version.py
+
+# Ruff
+.ruff_cache/

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: local
+    hooks:
+      - id: format
+        name: format
+        entry: bash -c "just fmt"
+        language: system
+      - id: lint
+        name: lint
+        entry: bash -c "just lint"
+        language: system

Justfile

@@ -11,10 +11,10 @@ default:
     #!/usr/bin/env bash
     {{ OPTIONS }}
 
-    just clean
     just deps
     just test
     just cov
+    just lint
     just build
 
 build:
@@ -23,7 +23,6 @@ build:
 
     {{ PYTHON }} -m build
 
-
 cov *args="report":
     #!/usr/bin/env bash
     {{ OPTIONS }}
@@ -39,7 +38,9 @@ clean:
     find . -name "__pycache__" -exec rm -rf {} +
     rm -rf\
         .coverage\
+        .mypy_cache\
         .pytest_cache\
+        .ruff_cache\
         *.egg-info\
         build\
         dist\
@@ -51,6 +52,19 @@ deps:
 
     {{ PIP }} install -e '.[test]'
 
+fmt:
+    #!/usr/bin/env bash
+    {{ OPTIONS }}
+
+    {{ PYTHON }} -m ruff format .
+
+lint:
+    #!/usr/bin/env bash
+    {{ OPTIONS }}
+
+    {{ PYTHON }} -m mypy --install-types --non-interactive .
+    {{ PYTHON }} -m ruff check
+
 test:
     #!/usr/bin/env bash
     {{ OPTIONS }}

pyproject.toml

@@ -25,7 +25,9 @@ dependencies = [
 [project.optional-dependencies]
 test = [
     "coverage",
+    "mypy",
     "pytest",
+    "ruff",
     "setuptools-scm"
 ]
 

src/posit/config_test.py

@@ -19,7 +19,7 @@ def test_get_endpoint(self):
     def test_get_value_miss(self):
         provider = EnvironmentConfigProvider()
         value = provider.get_value("foobar")
-        assert value == None
+        assert value is None
 
 
 class TestConfigBuilder: