From e4bb5ed355cecdea8299a870150dc48487500f1a Mon Sep 17 00:00:00 2001
From: Rob Ede <robjtede@icloud.com>
Date: Tue, 11 Jun 2024 03:52:02 +0100
Subject: [PATCH] build: group recipes

---
 justfile | 48 +++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 37 insertions(+), 11 deletions(-)

diff --git a/justfile b/justfile
index f94149f9c..99b848840 100644
--- a/justfile
+++ b/justfile
@@ -5,6 +5,8 @@
 _list:
     @just --list
 
+toolchain := ""
+
 msrv := ```
     cargo metadata --format-version=1 \
     | jq -r 'first(.packages[] | select(.source == null and .rust_version)) | .rust_version' \
@@ -13,52 +15,76 @@ msrv := ```
 msrv_rustup := "+" + msrv
 
 # Run Clippy over workspace.
-clippy toolchain="":
+[group("lint")]
+clippy:
     cargo {{ toolchain }} clippy --workspace --all-targets --all-features
 
 # Format workspace.
+[group("lint")]
 fmt: update-readmes
     cargo +nightly fmt
     fd --hidden --extension=yml --extension=md --exec-batch npx -y prettier --write
 
 # Update READMEs from crate root documentation.
+[group("lint")]
 update-readmes:
     cd ./actix-cors && cargo rdme --force
     cd ./actix-session && cargo rdme --force
     cd ./actix-identity && cargo rdme --force
     npx -y prettier --write $(fd README.md)
 
+# Test workspace docs.
+[group("test")]
+[group("docs")]
+test-docs:
+    cargo {{ toolchain }} test --doc --workspace --all-features --no-fail-fast -- --nocapture
+
 # Document crates in workspace.
-doc:
-    RUSTDOCFLAGS="--cfg=docsrs" cargo +nightly doc --no-deps --workspace --all-features
+[group("docs")]
+doc *args: && doc-set-workspace-crates
+    RUSTDOCFLAGS="--cfg=docsrs -Dwarnings" cargo +nightly doc --workspace --all-features {{ args }}
+
+[private]
+[group("docs")]
+doc-set-workspace-crates:
+    #!/usr/bin/env bash
+    (
+        echo "window.ALL_CRATES ="
+        cargo metadata --format-version=1 | jq '[.packages[] | select(.source == null) | .name]'
+        echo ";"
+    ) > "$(cargo metadata --format-version=1 | jq -r '.target_directory')/doc/crates.js"
 
 # Document crates in workspace and watch for changes.
+[group("docs")]
 doc-watch:
-    RUSTDOCFLAGS="--cfg=docsrs" cargo +nightly doc --no-deps --workspace --all-features --open
-    cargo watch -- RUSTDOCFLAGS="--cfg=docsrs" cargo +nightly doc --no-deps --workspace --all-features
+    @just doc --open
+    cargo watch -- just doc
 
 # Check for unintentional external type exposure on all crates in workspace.
-check-external-types-all toolchain="+nightly":
+[group("lint")]
+check-external-types-all:
     #!/usr/bin/env bash
     set -euo pipefail
     exit=0
     for f in $(find . -mindepth 2 -maxdepth 2 -name Cargo.toml | grep -vE "\-codegen/|\-derive/|\-macros/"); do
-        if ! just check-external-types-manifest "$f" {{toolchain}}; then exit=1; fi
+        if ! just toolchain={{ toolchain }} check-external-types-manifest "$f"; then exit=1; fi
         echo
         echo
     done
     exit $exit
 
 # Check for unintentional external type exposure on all crates in workspace.
-check-external-types-all-table toolchain="+nightly":
+[group("lint")]
+check-external-types-all-table:
     #!/usr/bin/env bash
     set -euo pipefail
     for f in $(find . -mindepth 2 -maxdepth 2 -name Cargo.toml | grep -vE "\-codegen/|\-derive/|\-macros/"); do
         echo
         echo "Checking for $f"
-        just check-external-types-manifest "$f" {{toolchain}} --output-format=markdown-table
+        just toolchain={{ toolchain }} check-external-types-manifest "$f" --output-format=markdown-table
     done
 
 # Check for unintentional external type exposure on a crate.
-check-external-types-manifest manifest_path toolchain="+nightly" *extra_args="":
-    cargo {{toolchain}} check-external-types --manifest-path "{{manifest_path}}" {{extra_args}}
+[group("lint")]
+check-external-types-manifest manifest_path *extra_args="":
+    cargo {{ toolchain }} check-external-types --manifest-path "{{ manifest_path }}" {{ extra_args }}