Skip to content

Commit f2a4919

Browse files
hyperpolymathclaude
andcommitted
feat: add UX Justfile with doctor, tour, help-me, assail recipes
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 4482c3a commit f2a4919

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

Justfile

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# SPDX-License-Identifier: PMPL-1.0-or-later
2+
# Justfile for formatrix-docs
3+
4+
# Default recipe — list available commands
5+
default:
6+
@just --list
7+
8+
# Self-diagnostic — checks dependencies, permissions, paths
9+
doctor:
10+
@echo "Running diagnostics for formatrix-docs..."
11+
@echo "Checking required tools..."
12+
@command -v just >/dev/null 2>&1 && echo " [OK] just" || echo " [FAIL] just not found"
13+
@command -v git >/dev/null 2>&1 && echo " [OK] git" || echo " [FAIL] git not found"
14+
@echo "Checking for hardcoded paths..."
15+
@grep -rn '/var/mnt/eclipse' --include='*.rs' --include='*.ex' --include='*.res' --include='*.gleam' --include='*.sh' --include='*.toml' . 2>/dev/null | grep -v 'Justfile' | head -5 || echo " [OK] No hardcoded paths in source"
16+
@echo "Diagnostics complete."
17+
18+
# Guided tour of key features
19+
tour:
20+
@echo "=== formatrix-docs Tour ==="
21+
@echo ""
22+
@echo "1. Project structure:"
23+
@ls -la
24+
@echo ""
25+
@echo "2. Available commands: just --list"
26+
@echo ""
27+
@echo "3. Read README.adoc or README.md for full overview"
28+
@echo "4. Read EXPLAINME.adoc for architecture decisions"
29+
@echo "5. Run 'just doctor' to check your setup"
30+
@echo ""
31+
@echo "Tour complete! Try 'just --list' to see all available commands."
32+
33+
# Open feedback channel with diagnostic context
34+
help-me:
35+
@echo "=== formatrix-docs Help ==="
36+
@echo "Platform: $(uname -s) $(uname -m)"
37+
@echo "Shell: $SHELL"
38+
@echo ""
39+
@echo "To report an issue:"
40+
@echo " https://github.com/hyperpolymath/formatrix-docs/issues/new"
41+
@echo ""
42+
@echo "Include the output of 'just doctor' in your report."
43+
44+
# Run panic-attacker pre-commit scan
45+
assail:
46+
@command -v panic-attack >/dev/null 2>&1 && panic-attack assail . || echo "WARN: panic-attack not found — install from https://github.com/hyperpolymath/panic-attacker"
47+
48+
# LLM context dump
49+
llm-context:
50+
@echo "Project: formatrix-docs"
51+
@echo "License: PMPL-1.0-or-later"
52+
@test -f README.adoc && head -30 README.adoc || test -f README.md && head -30 README.md || echo "No README found"

0 commit comments

Comments
 (0)