-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathjustfile
More file actions
873 lines (749 loc) · 30.9 KB
/
justfile
File metadata and controls
873 lines (749 loc) · 30.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# shellcheck disable=SC2148
# Justfile for delaunay development workflow
# Install just: https://github.com/casey/just
# Usage: just <command> or just --list
# Use bash with strict error handling for all recipes
set shell := ["bash", "-euo", "pipefail", "-c"]
cargo_llvm_cov_version := "0.8.5"
# Common cargo-llvm-cov arguments for all coverage runs.
# Excludes benches/examples from reports while allowing integration tests to
# exercise library code.
_coverage_base_args := '''--ignore-filename-regex '(^|/)(benches|examples)/' \
--workspace --lib --tests \
--verbose'''
_ensure-actionlint:
#!/usr/bin/env bash
set -euo pipefail
command -v actionlint >/dev/null || { echo "❌ 'actionlint' not found. See 'just setup' or https://github.com/rhysd/actionlint"; exit 1; }
_ensure-cargo-llvm-cov:
#!/usr/bin/env bash
set -euo pipefail
if ! command -v cargo-llvm-cov >/dev/null; then
echo "❌ 'cargo-llvm-cov' not found. See 'just setup-tools' or install:"
echo " cargo install --locked cargo-llvm-cov --version {{cargo_llvm_cov_version}}"
exit 1
fi
# Internal helpers: ensure external tooling is installed
_ensure-git-cliff:
#!/usr/bin/env bash
set -euo pipefail
command -v git-cliff >/dev/null || {
echo "❌ 'git-cliff' not found. Install via Homebrew: brew install git-cliff"
echo " Or via Cargo: cargo install git-cliff"
exit 1
}
_ensure-jq:
#!/usr/bin/env bash
set -euo pipefail
command -v jq >/dev/null || { echo "❌ 'jq' not found. See 'just setup' or install: brew install jq"; exit 1; }
_ensure-npx:
#!/usr/bin/env bash
set -euo pipefail
command -v npx >/dev/null || { echo "❌ 'npx' not found. See 'just setup' or install Node.js (for npx tools): https://nodejs.org"; exit 1; }
_ensure-prettier-or-npx:
#!/usr/bin/env bash
set -euo pipefail
if command -v prettier >/dev/null; then
exit 0
fi
command -v npx >/dev/null || {
echo "❌ Neither 'prettier' nor 'npx' found. Install via npm (recommended): npm i -g prettier"
echo " Or install Node.js (for npx): https://nodejs.org"
exit 1
}
_ensure-shellcheck:
#!/usr/bin/env bash
set -euo pipefail
command -v shellcheck >/dev/null || { echo "❌ 'shellcheck' not found. See 'just setup' or https://www.shellcheck.net"; exit 1; }
_ensure-shfmt:
#!/usr/bin/env bash
set -euo pipefail
command -v shfmt >/dev/null || { echo "❌ 'shfmt' not found. See 'just setup' or install: brew install shfmt"; exit 1; }
# Internal helper: ensure taplo is installed
_ensure-taplo:
#!/usr/bin/env bash
set -euo pipefail
command -v taplo >/dev/null || { echo "❌ 'taplo' not found. See 'just setup' or install: brew install taplo (or: cargo install taplo-cli)"; exit 1; }
# Internal helper: ensure typos-cli is installed
_ensure-typos:
#!/usr/bin/env bash
set -euo pipefail
command -v typos >/dev/null || { echo "❌ 'typos' not found. See 'just setup-tools' or install: cargo install typos-cli"; exit 1; }
# Internal helper: ensure uv is installed
_ensure-uv:
#!/usr/bin/env bash
set -euo pipefail
command -v uv >/dev/null || { echo "❌ 'uv' not found. See 'just setup' or https://github.com/astral-sh/uv"; exit 1; }
_ensure-yamllint:
#!/usr/bin/env bash
set -euo pipefail
command -v yamllint >/dev/null || { echo "❌ 'yamllint' not found. See 'just setup' or install: brew install yamllint"; exit 1; }
# GitHub Actions workflow validation
action-lint: _ensure-actionlint
#!/usr/bin/env bash
set -euo pipefail
files=()
while IFS= read -r -d '' file; do
files+=("$file")
done < <(git ls-files -z '.github/workflows/*.yml' '.github/workflows/*.yaml')
if [ "${#files[@]}" -gt 0 ]; then
printf '%s\0' "${files[@]}" | xargs -0 actionlint
else
echo "No workflow files found to lint."
fi
# Benchmark recipes that produce performance numbers use Cargo's perf profile.
bench:
cargo bench --workspace --profile perf
bench-baseline: _ensure-uv
uv run benchmark-utils generate-baseline
# CI regression benchmarks with the perf profile.
bench-ci:
cargo bench --profile perf --bench ci_performance_suite
bench-compare: _ensure-uv
uv run benchmark-utils compare --baseline baseline-artifact/baseline_results.txt
# Compile benchmarks without running them. Manifest lints enforce the warning
# policy without using RUSTFLAGS that fragment Cargo artifact caches.
bench-compile:
cargo bench --workspace --no-run
# Compile benchmarks and integration tests without running. This catches
# release-profile-only warnings (e.g. cfg-gated unused-mut) that debug-mode
# clippy/test won't see.
bench-test-compile:
cargo bench --workspace --no-run
cargo test --tests --release --no-run
# Development benchmark comparison: perf profile with reduced sample sizes.
bench-dev: _ensure-uv
CRIT_SAMPLE_SIZE=10 CRIT_MEASUREMENT_MS=1000 CRIT_WARMUP_MS=500 uv run benchmark-utils compare --baseline baseline-artifact/baseline_results.txt --dev
# Generate performance summary with fresh perf-profile benchmark runs (for releases)
bench-perf-summary: _ensure-uv
uv run benchmark-utils generate-summary --run-benchmarks --profile perf
# Smoke-test benchmark harnesses with minimal samples; not for performance data.
# Criterion requires sample_size >= 10; use the minimum with short measurement/warm-up windows.
bench-smoke:
CRIT_SAMPLE_SIZE=10 CRIT_MEASUREMENT_MS=500 CRIT_WARMUP_MS=200 cargo bench --workspace --profile perf
# Build commands
build:
cargo build
build-release:
cargo build --release
# Changelog management (git-cliff + post-processing + archiving)
changelog: _ensure-git-cliff python-sync
#!/usr/bin/env bash
set -euo pipefail
git-cliff -o CHANGELOG.md
uv run postprocess-changelog
uv run archive-changelog
changelog-tag version: python-sync
uv run tag-release {{version}}
changelog-update: changelog
@echo "📝 Changelog updated successfully!"
@echo "To create a git tag with changelog content for a specific version, run:"
@echo " just changelog-tag <version> # e.g., just changelog-tag v0.4.2"
# Check (non-mutating): run all linters/validators
check: lint
@echo "✅ Checks complete!"
# CI simulation: comprehensive validation (matches .github/workflows/ci.yml)
# Runs: checks + test workflow + examples
ci: check test examples
@echo "🎯 CI checks complete!"
# CI with performance baseline
ci-baseline tag="ci":
just ci
just perf-baseline {{tag}}
# CI + slow/stress tests (100+ vertices, stress tests)
ci-slow: ci test-slow
@echo "✅ CI + slow tests passed!"
# Clean build artifacts
clean:
cargo clean
rm -rf target/llvm-cov
rm -rf coverage_report
rm -rf coverage
# Code quality and formatting
clippy:
# SlotMap backend (disabled default DenseSlotMap)
cargo clippy --workspace --all-targets --no-default-features -- -D warnings -W clippy::pedantic -W clippy::nursery -W clippy::cargo
# DenseSlotMap backend (default)
cargo clippy --workspace --all-targets -- -D warnings -W clippy::pedantic -W clippy::nursery -W clippy::cargo
# All features
cargo clippy --workspace --all-targets --all-features -- -D warnings -W clippy::pedantic -W clippy::nursery -W clippy::cargo
# Compare SlotMap vs DenseSlotMap storage backends
compare-storage: _ensure-uv
@echo "📊 Comparing SlotMap vs DenseSlotMap performance (~4-6 hours)"
uv run compare-storage-backends --bench large_scale_performance
compare-storage-large: _ensure-uv
@echo "📊 Comparing storage backends at large scale (~8-12 hours, use on compute cluster)"
BENCH_LARGE_SCALE=1 uv run compare-storage-backends --bench large_scale_performance
# Coverage analysis for local development (HTML output)
coverage: _ensure-cargo-llvm-cov
mkdir -p target/llvm-cov
cargo llvm-cov {{_coverage_base_args}} --html --output-dir target/llvm-cov
@echo "📊 Coverage report generated: target/llvm-cov/html/index.html"
# Coverage analysis for CI (XML output for codecov/codacy)
coverage-ci: _ensure-cargo-llvm-cov
mkdir -p coverage
cargo llvm-cov {{_coverage_base_args}} --cobertura --output-path coverage/cobertura.xml -- --skip prop_
debug-large-scale-3d n="10000":
DELAUNAY_BULK_PROGRESS_EVERY=100 DELAUNAY_LARGE_DEBUG_MAX_RUNTIME_SECS=1800 DELAUNAY_LARGE_DEBUG_N_3D={{n}} cargo test --release --test large_scale_debug debug_large_scale_3d -- --ignored --exact --nocapture
debug-large-scale-4d n="3000":
DELAUNAY_BULK_PROGRESS_EVERY=100 DELAUNAY_LARGE_DEBUG_MAX_RUNTIME_SECS=1800 DELAUNAY_LARGE_DEBUG_N_4D={{n}} cargo test --release --test large_scale_debug debug_large_scale_4d -- --ignored --exact --nocapture
debug-large-scale-5d n="1000":
DELAUNAY_BULK_PROGRESS_EVERY=100 DELAUNAY_LARGE_DEBUG_MAX_RUNTIME_SECS=1800 DELAUNAY_LARGE_DEBUG_N_5D={{n}} cargo test --release --test large_scale_debug debug_large_scale_5d -- --ignored --exact --nocapture
# Default recipe shows available commands
default:
@just --list
doc-check:
RUSTDOCFLAGS='-D warnings' cargo doc --workspace --no-deps --document-private-items
# Examples and validation
examples:
./scripts/run_all_examples.sh
# Fix (mutating): apply formatters/auto-fixes
fix: toml-fmt fmt python-fix shell-fmt markdown-fix yaml-fix
@echo "✅ Fixes applied!"
fmt:
cargo fmt --all
fmt-check:
cargo fmt --all -- --check
help-workflows:
@echo "Recommended Just workflow:"
@echo " just fix # Apply formatters/auto-fixes (mutating)"
@echo " just check # Run all non-mutating lints/validators"
@echo " just test # Run tests + default-profile benchmark/release compile smoke"
@echo " just ci # Comprehensive checks + tests + examples"
@echo ""
@echo "Focused testing:"
@echo " just test-unit # Lib and doc tests only"
@echo " just test-integration # All integration tests (includes proptests)"
@echo " just test-integration-fast # Integration tests (skips proptests)"
@echo " just test-python # Python tests only (pytest)"
@echo " just test-slow # Run slow/stress tests with --features slow-tests"
@echo " just examples # Run all examples"
@echo ""
@echo "Active large-scale debugging:"
@echo " just test-debug # Run debug tools with output"
@echo " just debug-large-scale-4d [n] # Issue #340: 4D large-scale runtime (default n=3000)"
@echo " just debug-large-scale-3d [n] # Issue #341: 3D scalability (default n=10000)"
@echo " just debug-large-scale-5d [n] # Issue #342: 5D feasibility (default n=1000)"
@echo ""
@echo "Benchmark workflows (explicit perf-profile runs):"
@echo " just bench-smoke # Smoke-test benchmark harnesses (minimal samples)"
@echo " just bench # Run all benchmarks with perf profile (ThinLTO)"
@echo " just bench-baseline # Generate perf-profile performance baseline"
@echo " just bench-ci # CI regression benchmarks with perf profile (~5-10 min)"
@echo " just bench-compare # Compare against baseline with perf profile"
@echo " just bench-dev # Reduced-sample perf-profile comparison (~1-2 min)"
@echo " just bench-perf-summary # Generate perf-profile release summary (~30-45 min)"
@echo ""
@echo "Larger/optional workflows:"
@echo " just ci-slow # CI + slow tests (100+ vertices)"
@echo " just ci-baseline # CI + save performance baseline"
@echo " just coverage # Generate coverage report (HTML)"
@echo " just semgrep # Run repository-owned Semgrep rules"
@echo " just compare-storage # Compare SlotMap vs DenseSlotMap (~4-6 hours)"
@echo " just compare-storage-large # Large scale comparison (~8-12 hours, compute cluster)"
@echo ""
@echo "Use 'just --list' for every granular recipe."
# All linting: code + documentation + configuration
lint: lint-code lint-docs lint-config
# Code linting: Rust (fmt-check, clippy, docs) + Python (ruff, ty, mypy) + Shell scripts
lint-code: fmt-check clippy doc-check python-lint shell-lint
# Configuration validation: JSON, TOML, YAML, GitHub Actions workflows
lint-config: validate-json toml-lint toml-fmt-check yaml-lint action-lint
# Documentation linting: Markdown + spell checking
lint-docs: markdown-check spell-check
markdown-check: _ensure-npx
#!/usr/bin/env bash
set -euo pipefail
files=()
while IFS= read -r -d '' file; do
files+=("$file")
done < <(git ls-files -z '*.md')
if [ "${#files[@]}" -gt 0 ]; then
printf '%s\0' "${files[@]}" | xargs -0 -n100 npx markdownlint --config .markdownlint.json
else
echo "No markdown files found to check."
fi
# Shell, markdown, and YAML quality
markdown-fix: _ensure-npx
#!/usr/bin/env bash
set -euo pipefail
files=()
while IFS= read -r -d '' file; do
files+=("$file")
done < <(git ls-files -z '*.md')
if [ "${#files[@]}" -gt 0 ]; then
echo "📝 markdownlint --fix (${#files[@]} files)"
printf '%s\0' "${files[@]}" | xargs -0 -n100 npx markdownlint --config .markdownlint.json --fix
else
echo "No markdown files found to format."
fi
markdown-lint: markdown-check
# Performance analysis framework
perf-baseline tag="": _ensure-uv
#!/usr/bin/env bash
set -euo pipefail
tag_value="{{tag}}"
if [ -n "$tag_value" ]; then
uv run benchmark-utils generate-baseline --tag "$tag_value"
else
uv run benchmark-utils generate-baseline
fi
perf-check threshold="5.0": _ensure-uv
#!/usr/bin/env bash
set -euo pipefail
if [ -f "baseline-artifact/baseline_results.txt" ]; then
uv run benchmark-utils compare --baseline baseline-artifact/baseline_results.txt --threshold {{threshold}}
else
echo "❌ No baseline found. Run 'just perf-baseline' first."
exit 1
fi
perf-compare file: _ensure-uv
uv run benchmark-utils compare --baseline "{{file}}"
perf-help:
@echo "Performance Analysis Commands:"
@echo " just perf-baseline [tag] # Save current performance as baseline (optionally tagged)"
@echo " just perf-check [threshold] # Check for regressions (default: 5% threshold)"
@echo " just perf-compare <file> # Compare with specific baseline file"
@echo " just bench-dev # Reduced-sample perf-profile comparison"
@echo " just bench-smoke # Smoke-test benchmark harnesses"
@echo ""
@echo "Profiling Commands:"
@echo " just profile # Profile full triangulation_scaling benchmark"
@echo " just profile-dev # Profile 3D dev mode (faster iteration)"
@echo " just profile-mem # Profile memory allocations (with count-allocations feature)"
@echo ""
@echo "Benchmark System (Delaunay-specific):"
@echo " just bench-baseline # Generate baseline via benchmark-utils"
@echo " just bench-compare # Compare against stored baseline"
@echo " just bench # Full benchmark suite with perf profile"
@echo " just bench-ci # CI benchmark suite with perf profile"
@echo " just bench-dev # Reduced-sample perf-profile comparison"
@echo " just bench-smoke # Smoke-test benchmark harnesses"
@echo ""
@echo "Environment Variables (Benchmark Configuration):"
@echo " CRIT_SAMPLE_SIZE=N # Number of samples per benchmark"
@echo " CRIT_MEASUREMENT_MS=N # Measurement time in milliseconds"
@echo " CRIT_WARMUP_MS=N # Warm-up time in milliseconds"
@echo " DELAUNAY_BENCH_SEED=N # Random seed (decimal or 0x-hex)"
@echo ""
@echo "Examples:"
@echo " just perf-baseline v1.0.0 # Save tagged baseline"
@echo " just perf-check 10.0 # Check with 10% threshold"
@echo " just bench-dev # Reduced-sample benchmark iteration"
@echo " CRIT_SAMPLE_SIZE=100 just bench # Custom sample size"
@echo " just bench-ci # Final optimized CI-suite benchmark run"
# Profiling
profile:
samply record cargo bench --profile perf --bench profiling_suite -- triangulation_scaling
profile-dev:
PROFILING_DEV_MODE=1 samply record cargo bench --profile perf --bench profiling_suite -- "triangulation_scaling_3d/tds_new/random_3d"
profile-mem:
samply record cargo bench --profile perf --bench profiling_suite --features count-allocations -- memory_profiling
# Pre-publish validation: checks crates.io metadata rules that cargo publish --dry-run does NOT catch
publish-check: _ensure-jq
#!/usr/bin/env bash
set -euo pipefail
echo "🔍 Validating crates.io metadata..."
errors=0
# Keywords: max 5, each ≤20 chars, ASCII alphanumeric/hyphen only
keywords=$(cargo metadata --no-deps --format-version=1 2>/dev/null \
| jq -r '.packages[0].keywords[]')
count=0
while IFS= read -r kw; do
[[ -z "$kw" ]] && continue
count=$((count + 1))
if (( ${#kw} > 20 )); then
echo " ❌ keyword '${kw}' exceeds 20-char limit (${#kw} chars)"
errors=1
fi
if ! [[ "$kw" =~ ^[a-zA-Z0-9_-]+$ ]]; then
echo " ❌ keyword '${kw}' contains invalid characters"
errors=1
fi
done <<< "$keywords"
if (( count > 5 )); then
echo " ❌ too many keywords ($count > 5)"
errors=1
fi
echo " ✓ keywords ($count): $keywords"
# Categories: max 5
cat_count=$(cargo metadata --no-deps --format-version=1 2>/dev/null \
| jq '.packages[0].categories | length')
if (( cat_count > 5 )); then
echo " ❌ too many categories ($cat_count > 5)"
errors=1
fi
echo " ✓ categories ($cat_count)"
# Description: required, ≤1000 chars
desc=$(cargo metadata --no-deps --format-version=1 2>/dev/null \
| jq -r '.packages[0].description // ""')
if [[ -z "$desc" ]]; then
echo " ❌ description is missing"
errors=1
elif (( ${#desc} > 1000 )); then
echo " ❌ description exceeds 1000-char limit (${#desc} chars)"
errors=1
fi
echo " ✓ description (${#desc} chars)"
if (( errors )); then
echo ""
echo "❌ Metadata validation failed. Fix Cargo.toml before publishing."
exit 1
fi
echo ""
echo "📦 Running cargo publish --dry-run..."
cargo publish --locked --allow-dirty --dry-run
echo ""
echo "✅ Publish check passed!"
python-check: _ensure-uv
uv run ruff format --check scripts/
uv run ruff check scripts/
just python-typecheck
# Python code quality
python-fix: _ensure-uv
uv run ruff check scripts/ --fix
uv run ruff format scripts/
python-lint: python-check
python-sync: _ensure-uv
uv sync --group dev
python-typecheck: _ensure-uv
uv run ty check scripts/ --error all
# Repository-owned Semgrep rules. Currently opt-in because the Rust rules are
# staged but disabled while legacy diagnostics are cleaned up.
semgrep: _ensure-uv
uv run semgrep --config .semgrep.yaml .
# Development setup
setup: setup-tools
#!/usr/bin/env bash
set -euo pipefail
echo "Setting up delaunay development environment..."
echo "Note: Rust toolchain and components managed by rust-toolchain.toml (if present)"
echo ""
echo "Installing Python tooling..."
uv sync --group dev
echo ""
echo "Building project..."
cargo build
echo "✅ Setup complete! Run 'just help-workflows' to see available commands."
# Development tooling installation (best-effort)
#
# Note: this recipe is intentionally self-contained. If it grows further, consider splitting
# it into smaller helper recipes (e.g. brew installs, cargo tool installs, verification).
setup-tools:
#!/usr/bin/env bash
set -euo pipefail
echo "🔧 Ensuring tooling required by just recipes is installed..."
echo ""
os="$(uname -s || true)"
have() { command -v "$1" >/dev/null 2>&1; }
install_with_brew() {
local formula="$1"
if brew list --versions "$formula" >/dev/null 2>&1; then
echo " ✓ $formula (brew)"
else
echo " ⏳ Installing $formula (brew)..."
HOMEBREW_NO_AUTO_UPDATE=1 brew install "$formula"
fi
}
brew_available=0
if have brew; then
brew_available=1
echo "Using Homebrew (brew) to install missing tools..."
install_with_brew uv
install_with_brew jq
install_with_brew taplo
install_with_brew yamllint
install_with_brew shfmt
install_with_brew shellcheck
install_with_brew actionlint
install_with_brew node
echo ""
else
echo "⚠️ 'brew' not found. Skipping Homebrew installs."
if [[ "$os" == "Darwin" ]]; then
echo "Install Homebrew from https://brew.sh, or ensure required tools are on PATH."
else
echo "Install required tools via your system package manager, or ensure they are on PATH."
fi
echo "Required tools: uv, jq, taplo, yamllint, shfmt, shellcheck, actionlint, git-cliff, node+npx, typos"
echo ""
fi
echo "Ensuring Rust toolchain + components..."
if ! have rustup; then
echo "❌ 'rustup' not found. Install Rust via https://rustup.rs and re-run: just setup-tools"
exit 1
fi
rustup component add clippy rustfmt rust-docs rust-src
echo ""
echo "Ensuring cargo tools..."
if ! have samply; then
echo " ⏳ Installing samply (cargo)..."
cargo install --locked samply
else
echo " ✓ samply"
fi
if ! have typos; then
echo " ⏳ Installing typos-cli (cargo)..."
cargo install --locked typos-cli
else
echo " ✓ typos"
fi
if ! have git-cliff; then
echo " ⏳ Installing git-cliff (cargo)..."
cargo install --locked git-cliff
else
echo " ✓ git-cliff"
fi
if ! rustup component list --installed | grep -q '^llvm-tools'; then
echo " ⏳ Installing llvm-tools-preview (rustup)..."
rustup component add llvm-tools-preview
else
echo " ✓ llvm-tools-preview"
fi
if ! have cargo-llvm-cov; then
echo " ⏳ Installing cargo-llvm-cov {{cargo_llvm_cov_version}} (cargo)..."
cargo install --locked cargo-llvm-cov --version {{cargo_llvm_cov_version}}
else
echo " ✓ cargo-llvm-cov"
fi
echo ""
echo "Verifying required commands are available..."
missing=0
cmds=(uv jq taplo yamllint shfmt shellcheck actionlint git-cliff node npx typos)
cmds+=(cargo-llvm-cov)
for cmd in "${cmds[@]}"; do
if have "$cmd"; then
echo " ✓ $cmd"
else
echo " ✗ $cmd"
missing=1
fi
done
if [ "$missing" -ne 0 ]; then
echo ""
echo "❌ Some required tools are still missing."
if [ "$brew_available" -ne 0 ]; then
echo "Fix the installs above (brew) and re-run: just setup-tools"
else
if [[ "$os" == "Darwin" ]]; then
echo "Install Homebrew (https://brew.sh) or install the missing tools manually, then re-run: just setup-tools"
else
echo "Install the missing tools via your system package manager, then re-run: just setup-tools"
fi
fi
exit 1
fi
echo ""
echo "✅ Tooling setup complete."
# Shell scripts: lint/check (non-mutating)
shell-check: _ensure-shellcheck _ensure-shfmt
#!/usr/bin/env bash
set -euo pipefail
files=()
while IFS= read -r -d '' file; do
files+=("$file")
done < <(git ls-files -z '*.sh')
if [ "${#files[@]}" -gt 0 ]; then
printf '%s\0' "${files[@]}" | xargs -0 -n4 shellcheck -x
printf '%s\0' "${files[@]}" | xargs -0 shfmt -d
else
echo "No shell files found to check."
fi
# Shell scripts: format (mutating)
shell-fmt: _ensure-shfmt
#!/usr/bin/env bash
set -euo pipefail
files=()
while IFS= read -r -d '' file; do
files+=("$file")
done < <(git ls-files -z '*.sh')
if [ "${#files[@]}" -gt 0 ]; then
echo "🧹 shfmt -w (${#files[@]} files)"
printf '%s\0' "${files[@]}" | xargs -0 shfmt -w
else
echo "No shell files found to format."
fi
# Note: justfiles are not shell scripts and are excluded from shellcheck
shell-lint: shell-check
# Spell check (typos)
spell-check: _ensure-typos
#!/usr/bin/env bash
set -euo pipefail
files=()
# Use -z for NUL-delimited output to handle filenames with spaces.
#
# Note: For renames/copies, `git status --porcelain -z` emits *two* NUL-separated paths.
# The ordering can differ depending on the porcelain output, so we read both and
# spell-check whichever one exists on disk.
while IFS= read -r -d '' status_line; do
status="${status_line:0:2}"
filename="${status_line:3}"
# For renames/copies, consume the second path token to keep parsing in sync.
# Prefer the path that exists on disk to avoid passing stale paths to typos.
if [[ "$status" == *"R"* || "$status" == *"C"* ]]; then
if IFS= read -r -d '' other_path; then
if [ ! -e "$filename" ] && [ -e "$other_path" ]; then
filename="$other_path"
fi
fi
fi
# Skip deletions (file may no longer exist).
if [[ "$status" == *"D"* ]]; then
continue
fi
files+=("$filename")
done < <(git status --porcelain -z --ignored=no)
if [ "${#files[@]}" -gt 0 ]; then
# Exclude typos.toml itself: it intentionally contains allowlisted fragments.
printf '%s\0' "${files[@]}" | xargs -0 -n100 typos --config typos.toml --force-exclude --exclude typos.toml --
else
echo "No modified files to spell-check."
fi
# Create an annotated git tag from the CHANGELOG.md section for the given version
tag version: python-sync
uv run tag-release {{version}}
# Recreate an existing tag (delete + recreate)
tag-force version: python-sync
uv run tag-release {{version}} --force
# Testing
# test: runs default-profile benchmark/release compile checks plus all tests.
test: bench-test-compile test-all
@echo "✅ Test workflow passed!"
# test-unit: runs lib and doc tests.
test-unit:
cargo test --lib --verbose
cargo test --doc --verbose
# test-all: runs lib, doc, integration, and Python tests (comprehensive)
test-all: test-unit test-integration test-python
@echo "✅ All tests passed!"
test-allocation:
cargo test --test allocation_api --features count-allocations -- --nocapture
test-debug:
cargo test --test circumsphere_debug_tools -- --nocapture
# test-integration: runs all integration tests (includes proptests) in release mode.
# Release mode is required because exact-predicate arithmetic in debug mode makes
# 3D+ proptests exceed CI timeout limits (>60s debug vs <1s release).
test-integration:
cargo test --tests --release --verbose
# test-integration-fast: runs integration tests but skips proptests (tests prefixed with `prop_`)
#
# Useful for quick local validation on changes that don't touch the property-test surface area.
# To run the full (slow) property suite, use: just test-integration
#
# Note: `--skip prop_` is a substring filter applied by the Rust test harness.
test-integration-fast:
cargo test --tests --release --verbose -- --skip prop_
test-python: _ensure-uv
uv run pytest
test-release:
cargo test --release
# Run tests including slow/stress tests (100+ vertices, multiple dimensions)
# These are gated behind the 'slow-tests' feature to keep CI fast
test-slow:
cargo test --features slow-tests
test-slow-release:
cargo test --release --features slow-tests
toml-fmt: _ensure-taplo
#!/usr/bin/env bash
set -euo pipefail
files=()
while IFS= read -r -d '' file; do
files+=("$file")
done < <(git ls-files -z '*.toml')
if [ "${#files[@]}" -gt 0 ]; then
taplo fmt "${files[@]}"
else
echo "No TOML files found to format."
fi
toml-fmt-check: _ensure-taplo
#!/usr/bin/env bash
set -euo pipefail
files=()
while IFS= read -r -d '' file; do
files+=("$file")
done < <(git ls-files -z '*.toml')
if [ "${#files[@]}" -gt 0 ]; then
taplo fmt --check "${files[@]}"
else
echo "No TOML files found to check."
fi
toml-lint: _ensure-taplo
#!/usr/bin/env bash
set -euo pipefail
files=()
while IFS= read -r -d '' file; do
files+=("$file")
done < <(git ls-files -z '*.toml')
if [ "${#files[@]}" -gt 0 ]; then
taplo lint "${files[@]}"
else
echo "No TOML files found to lint."
fi
# File validation
validate-json: _ensure-jq
#!/usr/bin/env bash
set -euo pipefail
files=()
while IFS= read -r -d '' file; do
files+=("$file")
done < <(git ls-files -z '*.json')
if [ "${#files[@]}" -gt 0 ]; then
printf '%s\0' "${files[@]}" | xargs -0 -n1 jq empty
else
echo "No JSON files found to validate."
fi
validate-toml: _ensure-uv
#!/usr/bin/env bash
set -euo pipefail
files=()
while IFS= read -r -d '' file; do
files+=("$file")
done < <(git ls-files -z '*.toml')
if [ "${#files[@]}" -gt 0 ]; then
printf '%s\0' "${files[@]}" | xargs -0 -I {} uv run python -c "import tomllib; tomllib.load(open('{}', 'rb')); print('{} is valid TOML')"
else
echo "No TOML files found to validate."
fi
yaml-fix: _ensure-prettier-or-npx
#!/usr/bin/env bash
set -euo pipefail
files=()
while IFS= read -r -d '' file; do
files+=("$file")
done < <(git ls-files -z '*.yml' '*.yaml')
if [ "${#files[@]}" -gt 0 ]; then
echo "📝 prettier --write (YAML, ${#files[@]} files)"
cmd=()
if command -v prettier >/dev/null; then
cmd=(prettier --write --print-width 120)
elif command -v npx >/dev/null; then
# Prefer non-interactive installs when supported (newer npm/npx).
# NOTE: With `set -u`, expanding an empty array like "${arr[@]}" can error on older bash.
cmd=(npx)
if npx --help 2>&1 | grep -q -- '--yes'; then
cmd+=(--yes)
fi
cmd+=(prettier --write --print-width 120)
else
echo "❌ 'prettier' not found. Install via npm (recommended): npm i -g prettier"
echo " Or install Node.js (for npx): https://nodejs.org"
exit 1
fi
# Use CLI flags instead of a repo-wide prettier config: keeps the scope to YAML only.
printf '%s\0' "${files[@]}" | xargs -0 -n100 "${cmd[@]}"
else
echo "No YAML files found to format."
fi
yaml-lint: _ensure-yamllint
#!/usr/bin/env bash
set -euo pipefail
files=()
while IFS= read -r -d '' file; do
files+=("$file")
done < <(git ls-files -z '*.yml' '*.yaml')
if [ "${#files[@]}" -gt 0 ]; then
echo "🔍 yamllint (${#files[@]} files)"
yamllint --strict -c .yamllint "${files[@]}"
else
echo "No YAML files found to lint."
fi