Use just as command runner, replacing nox (#112)

Author: SRv6d

.devcontainer/devcontainer.json

@@ -1,12 +1,16 @@
 {
   "name": "Python 3",
   "image": "ghcr.io/astral-sh/uv:python3.11-bookworm",
+  "features": {
+    "ghcr.io/guiyomh/features/just:0": {}
+  },
   "customizations": {
     "vscode": {
       "extensions": [
         "ms-python.python",
         "charliermarsh.ruff",
         "fill-labs.dependi",
+        "nefrob.vscode-just-syntax",
         "EditorConfig.EditorConfig"
       ]
     }

.github/CONTRIBUTING.md

@@ -26,22 +26,24 @@ For users of IDEs with support for devcontainers, it's usage is recommended.
 
 ### Other
 
-Ensure you have Python 3.11 or greater with recent versions of [uv] and [nox] in your environment.
+Ensure you have Python 3.11 or greater with recent versions of [uv] and [just] in your environment.
 
 ## Coding Standards
 
-All tests need to pass before a PR can be merged. Using [nox] to lint your code and run tests
+All tests need to pass before a PR can be merged. Using [just] to lint your code and run tests
 before creating a PR is advised to avoid being reprimanded by CI.
 
 ```sh
-$ nox
-nox > Running session lint-3.11
+$ just
+uv lock --locked
+Resolved 54 packages in 3ms
+uv run ruff check src tests
+All checks passed!
+uv run ruff format --check src tests
+57 files already formatted
+uv run mypy src
+Success: no issues found in 30 source files
 ...
-nox > Ran multiple sessions:
-nox > * lint-3.11: success
-nox > * lint-3.12: skipped
-nox > * test-3.11: success
-nox > * test-3.12: skipped
 ```
 
 Since some integration tests use real dependencies, docker is required to run them. If docker is not available in your environment, those tests will be skipped and only run in CI.
@@ -88,6 +90,6 @@ as well as [mypy] for static type checks.
   ```
 
 [uv]: https://github.com/astral-sh/uv
-[nox]: https://github.com/wntrblm/nox
+[just]: https://github.com/casey/just
 [ruff]: https://github.com/astral-sh/ruff
 [mypy]: https://github.com/python/mypy

.github/workflows/test.yml

@@ -33,11 +33,14 @@ jobs:
         with:
           enable-cache: true
       - run: uv python install ${{ matrix.python_version }}
-      - run: uvx nox -s test
+      - uses: extractions/setup-just@v2
+
+      - run: just test
+
       - name: Upload coverage reports to Codecov
         uses: codecov/[email protected]
         with:
-          files: ./coverage.xml,!./nox
+          files: ./coverage.xml
           env_vars: PYTHON
           use_oidc: true
           fail_ci_if_error: true

.github/workflows/verify.yml

@@ -17,7 +17,9 @@ jobs:
         with:
           enable-cache: true
       - run: uv python install ${{ env.PYTHON_VERSION }}
-      - run: uvx nox -s lint
+      - uses: extractions/setup-just@v2
+
+      - run: just lint
   check-lockfile:
     runs-on: ubuntu-latest
     steps:
@@ -26,7 +28,9 @@ jobs:
         with:
           enable-cache: true
       - run: uv python install ${{ env.PYTHON_VERSION }}
-      - run: uvx nox -s lockfile
+      - uses: extractions/setup-just@v2
+
+      - run: just check-lockfile
   type-check:
     runs-on: ubuntu-latest
     steps:
@@ -35,7 +39,9 @@ jobs:
         with:
           enable-cache: true
       - run: uv python install ${{ env.PYTHON_VERSION }}
-      - run: uvx nox -s mypy
+      - uses: extractions/setup-just@v2
+
+      - run: just type-check
   spellcheck:
     runs-on: ubuntu-latest
     steps:

justfile

@@ -0,0 +1,29 @@
+FRR_LATEST_MAJOR_VERSION := "9.1.0"
+
+default: check-lockfile lint type-check test
+
+# Check if the lockfile is up to date
+check-lockfile:
+  uv lock --locked
+
+# Lint code and check formatting using ruff
+lint +dirs="src tests":
+  uv run ruff check {{ dirs }}
+  uv run ruff format --check {{ dirs }}
+
+# Validate static types using mypy
+type-check +dirs="src":
+  uv run mypy {{ dirs }}
+
+# Run tests using pytest
+test $COV=env("CI", "false") $FRR_VERSION=FRR_LATEST_MAJOR_VERSION:
+  #!/usr/bin/env bash
+  set -euxo pipefail
+
+  args=()
+  ( $COV == "true" ) && args+=( "--cov" )
+  uv run pytest tests ${args[@]}
+
+  if [ $COV = "true" ]; then
+    uv run coverage xml
+  fi