mab122
/
radicle-heartwood-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

just: Introduce output formatting

This commit is contained in:
Adrian Duke 2026-04-08 18:25:48 +01:00 committed by Fintan Halpenny
parent bdb2a1fc7f
commit eb8467cb6f
1 changed files with 27 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
justfile
View File

@ -1,4 +1,14 @@
default: hooks := "pre-commit pre-push post-checkout"
hook-script := "scripts/git-hook-template.sh"
bold_underlined := BOLD + UNDERLINE
WARN := "⚠️ " + YELLOW + bold_underlined
SUCCESS := "✅ " + GREEN + bold_underlined
ERROR := "❌ " + RED + bold_underlined
HINT := "💡 " + BOLD
CHECK := "🔄 " + BOLD
default: check-hooks
@just --list @just --list
# SECURITY: We COPY the hook template instead of symlinking it. This ensures that # SECURITY: We COPY the hook template instead of symlinking it. This ensures that
@ -18,7 +28,9 @@ install-hooks:
# Run pre-commit checks # Run pre-commit checks
[group('hooks')] [group('hooks')]
pre-commit: format-rust check-rust check-docs check-typos check-spelling check-scripts check-keywords format-nix pre-commit: format-rust check-rust check-docs check-typos check-spelling check-scripts check-keywords format-nix
@echo "✅ pre-commit passed" @echo ""
@echo "{{SUCCESS}}pre-commit passed!{{NORMAL}}"
@echo ""
# Format Rust code # Format Rust code
[group('pre-commit')] [group('pre-commit')]
@ -26,7 +38,7 @@ pre-commit: format-rust check-rust check-docs check-typos check-spelling check-s
[group('format')] [group('format')]
[parallel] [parallel]
format-rust: (verify-tool "cargo") format-rust: (verify-tool "cargo")
@echo "Cargo fmt..." @echo "{{CHECK}}Cargo fmt...{{NORMAL}}"
@cargo fmt --all @cargo fmt --all
# Run cargo check # Run cargo check
@ -35,7 +47,7 @@ format-rust: (verify-tool "cargo")
[group('check')] [group('check')]
[parallel] [parallel]
check-rust: check-rust:
@echo "Cargo check..." @echo "{{CHECK}}Cargo check...{{NORMAL}}"
@cargo check --workspace --all-targets --all-features @cargo check --workspace --all-targets --all-features
# Check documentation for warnings # Check documentation for warnings
@ -44,7 +56,7 @@ check-rust:
[group('check')] [group('check')]
[parallel] [parallel]
check-docs: check-docs:
@echo "Checking docs for warnings..." @echo "{{CHECK}}Checking docs for warnings...{{NORMAL}}"
@RUSTDOCFLAGS="--deny warnings" cargo doc --workspace --all-features --no-deps @RUSTDOCFLAGS="--deny warnings" cargo doc --workspace --all-features --no-deps
# Check for typos # Check for typos
@ -53,7 +65,7 @@ check-docs:
[group('check')] [group('check')]
[parallel] [parallel]
check-typos: (verify-tool "typos" "typos-cli") check-typos: (verify-tool "typos" "typos-cli")
@echo "Checking for spelling typos..." @echo "{{CHECK}}Checking for spelling typos...{{NORMAL}}"
@typos @typos
# Run codespell # Run codespell
@ -62,7 +74,7 @@ check-typos: (verify-tool "typos" "typos-cli")
[group('check')] [group('check')]
[parallel] [parallel]
check-spelling: (verify-tool "codespell") check-spelling: (verify-tool "codespell")
@echo "Checking for code typos..." @echo "{{CHECK}}Checking for code typos...{{NORMAL}}"
@git ls-files -z | xargs -0 codespell -w @git ls-files -z | xargs -0 codespell -w
# Run shellcheck on all shell scripts # Run shellcheck on all shell scripts
@ -71,7 +83,7 @@ check-spelling: (verify-tool "codespell")
[group('check')] [group('check')]
[parallel] [parallel]
check-scripts: (verify-tool "shellcheck") check-scripts: (verify-tool "shellcheck")
@echo "Checking shell scripts..." @echo "{{CHECK}}Checking shell scripts...{{NORMAL}}"
@shellcheck scripts/*.sh @shellcheck scripts/*.sh
# Replicate the custom grep checks from flake.nix # Replicate the custom grep checks from flake.nix
@ -82,7 +94,7 @@ check-scripts: (verify-tool "shellcheck")
check-keywords: (verify-tool "rg" "ripgrep") check-keywords: (verify-tool "rg" "ripgrep")
#! /usr/bin/env bash #! /usr/bin/env bash
set -e set -e
echo "Checking for forbidden words in staged files..." echo "{{CHECK}}Checking for forbidden words in staged files...{{NORMAL}}"
# Get staged Rust files # Get staged Rust files
STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACMR | grep '\.rs$' || true) STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACMR | grep '\.rs$' || true)
@ -114,12 +126,14 @@ format-nix:
# Run pre-push checks # Run pre-push checks
[group('hooks')] [group('hooks')]
pre-push: format-rust check-rust check-keywords check-docs check-spelling check-scripts check-typos format-nix lint-rust pre-push: format-rust check-rust check-keywords check-docs check-spelling check-scripts check-typos format-nix lint-rust
@echo "✅ pre-push passed" @echo ""
@echo "{{SUCCESS}}pre-push passed!{{NORMAL}}"
@echo ""
# Run Clippy lints # Run Clippy lints
[group('pre-push')] [group('pre-push')]
lint-rust: (verify-tool "cargo") lint-rust: (verify-tool "cargo")
@echo "Cargo clippy..." @echo "{{CHECK}}Cargo clippy...{{NORMAL}}"
@cargo clippy --workspace --all-targets --all-features -- --deny warnings @cargo clippy --workspace --all-targets --all-features -- --deny warnings
# Check if required tools are in PATH. # Check if required tools are in PATH.
@ -132,7 +146,7 @@ verify-tool tool package_name="":
if [ -z "$PKG" ]; then if [ -z "$PKG" ]; then
PKG="{{tool}}" PKG="{{tool}}"
fi fi
echo "❌ Missing required tool: {{tool}}" echo "{{ERROR}}Missing required tool: {{tool + NORMAL}}"
echo "💡 Use your systems package manager to install '$PKG'." echo "{{HINT}}Use your systems package manager to install '$PKG'.{{NORMAL}}"
exit 1 exit 1
fi fi