replace make with just (#503)

Author: gruebel

.github/workflows/publish.yml

@@ -21,9 +21,9 @@ jobs:
       - run: uv sync --frozen
 
       - name: Install the package to make sure nothing is randomly broken
-        run: make build
+        run: just build-package
       - name: Run pytest (unit tests)
-        run: make test
+        run: just unit-tests
 
 
   publish-package:

.github/workflows/test.yml

@@ -22,6 +22,9 @@ jobs:
       - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c  # v6.0.0
         with:
           python-version-file: '.python-version'
+      - uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3.0.0
+        with:
+          just-version: '1'
       - uses: j178/prek-action@91fd7d7cf70ae1dee9f4f44e7dfa5d1073fe6623 # v1.0.11
         with:
           prek-version: ${{ env.PREK_VERSION }}
@@ -38,11 +41,11 @@ jobs:
       - run: uv sync --frozen
 
       - name: Install the package to make sure nothing is randomly broken
-        run: make build
+        run: just build-package
       - name: Run pytest (unit tests)
-        run: make test
+        run: just unit-tests
       - name: Run mypy (static type check)
-        run: make type-check
+        run: just type-check
 
   python-version:
     needs: prek
@@ -62,6 +65,6 @@ jobs:
       - run: uv sync --frozen
 
       - name: Install the package to make sure nothing is randomly broken
-        run: make build
+        run: just build-package
       - name: Run pytest (unit tests)
-        run: make test
+        run: just unit-tests

.github/workflows/update-bundle-report.yml

@@ -20,16 +20,11 @@ jobs:
       - run: uv sync --frozen
 
       - name: Update the JavaScript bundle
-        run: |
-          make build-js
-
+        run: just build-js
       - name: Generate the updated reports
-        run: |
-          make generate-report
-
+        run: just generate-report
       - name: Run NPM unit tests for sanity checks
-        run: |
-          make test-js
+        run: just test-js
 
       - name: PR if files were updated
         uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8

.nvmrc

@@ -1 +1 @@
-12
+20

.pre-commit-config.yaml

@@ -4,8 +4,15 @@ repos:
     hooks:
       - id: actionlint-docker
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.2
+    rev: v0.14.3
     hooks:
       - id: ruff-check
         files: ^(cloudsplaining/|setup.py)
       - id: ruff-format
+  - repo: local
+    hooks:
+      - id: just-fmt
+        name: just fmt
+        language: system
+        pass_filenames: false
+        entry: just --fmt --unstable

Makefile

@@ -0,0 +1,55 @@
+default:
+    @just --list
+
+[group('docs')]
+build-docs:
+    mkdocs build
+
+[group('js')]
+build-js: clean-js install-js
+    uv run ./utils/generate_example_iam_data.py
+    npm run build
+
+[group('package')]
+build-package: clean
+    uv build
+
+[group('package')]
+clean:
+    rm -rf dist/
+    rm -rf *.egg-info
+
+[group('js')]
+clean-js:
+    rm -rf node_modules/
+    npm cache clear --force
+
+[group('js')]
+generate-report:
+    uv run ./utils/generate_example_iam_data.py
+    uv run ./utils/generate_example_report.py
+
+[group('js')]
+install-js:
+    npm ci
+
+[group('docs')]
+serve-docs:
+    mkdocs serve --dev-addr "127.0.0.1:8001"
+
+[group('js')]
+serve-js: install-js
+    npm run serve
+
+[group('js')]
+test-js: install-js
+    npm test
+
+[group('test')]
+type-check:
+    mypy
+
+[group('test')]
+unit-tests:
+    coverage run -m pytest -v
+    coverage report -m

justfile

@@ -54,6 +54,7 @@ dev = [
     "mypy>=1.18.0,<2.0.0",
     "prek>=0.2.13,<0.3.0",
     "pytest>=8.4.0,<9.0.0",
+    "rust-just>=1.43.0,<2.0.0",
     "types-pyyaml>=6.0.12,<7.0.0",
 ]