-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathJustfile
More file actions
281 lines (239 loc) · 9.88 KB
/
Justfile
File metadata and controls
281 lines (239 loc) · 9.88 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
# SPDX-License-Identifier: PMPL-1.0-or-later
# fireflag - Development Tasks
set shell := ["bash", "-uc"]
set dotenv-load := true
project := "fireflag"
# Show all recipes
default:
@just --list --unsorted
# Build ReScript sources
build:
deno run -A npm:rescript build
# Build in watch mode
watch:
deno run -A npm:rescript build -w
# Clean build artifacts
clean:
deno run -A npm:rescript clean
rm -rf src/**/*.res.js src/**/*.bs.js
# Format ReScript code
fmt:
deno run -A npm:rescript format src/**/*.res
# Type check
check:
deno run -A npm:rescript build
# Run tests
test:
deno test --allow-read
# Run example
example:
deno run --allow-read src/example.js
# Lint (placeholder for future rescript-eslint)
lint:
@echo "Lint: Type checking via rescript build"
deno run -A npm:rescript build
# Extension development tasks
# --------------------------
# Build extension icons
icons:
cd extension/icons && ./generate-icons.sh
# Lint extension with web-ext
lint-ext:
cd extension && npx web-ext lint --warnings-as-errors
# Build extension .xpi
build-ext:
cd extension && npx web-ext build --overwrite-dest
# Run extension in Firefox
run-ext:
cd extension && npx web-ext run --firefox=firefox
# Sign extension for Mozilla Add-ons
sign-ext KEY SECRET:
cd extension && npx web-ext sign \
--api-key={{KEY}} \
--api-secret={{SECRET}} \
--channel=listed
# Containerization tasks
# -----------------------
# Build in Guix environment (local)
guix-build:
guix shell -m .containerization/guix-manifest.scm -- \
bash -c "deno run -A npm:rescript build && cd extension && deno run -A npm:web-ext build"
# Build using Guix package definition
guix-package:
guix build -f guix.scm
# Build with Docker/Podman (simple)
container-build:
podman build -f .containerization/Containerfile -t fireflag:latest .
# Build with complete orchestration (recommended)
container-build-full:
@echo "Running full containerized build with security scanning..."
bash .containerization/build.sh
# Build and extract artifacts
container-extract:
@echo "Building and extracting artifacts..."
BUILD_TAG=fireflag:build bash .containerization/build.sh
@echo "Artifacts available in build-output/"
# Clean container build artifacts
container-clean:
rm -rf build-output/
podman rmi fireflag:latest fireflag:build 2>/dev/null || true
@echo "Container artifacts cleaned"
# Run cerro-terro orchestration (if cerro-terro installed)
cerro-build:
@if command -v cerro-terro >/dev/null 2>&1; then \
cerro-terro run .containerization/cerro-terro.yml; \
else \
echo "cerro-terro not installed, using build.sh instead"; \
bash .containerization/build.sh; \
fi
# Security scanning tasks
# ------------------------
# Run all security scans
security-scan:
@echo "Running svalin static analysis..."
bash -c 'cd .github/workflows && bash svalin-scan.yml'
@echo "Running vordr verification..."
bash -c 'cd .github/workflows && bash vordr-verify.yml'
@echo "Running selur secrets detection..."
bash -c 'cd .github/workflows && bash selur-secrets.yml'
# Check Idris2 proofs
check-proofs:
cd extension/lib/idris && idris2 --check FlagSafety.idr
cd extension/lib/idris && idris2 --check FlagTransaction.idr
cd extension/lib/idris && idris2 --check SafeUI.idr
# Screenshots
# -----------
# Generate SVG mockup screenshots
generate-mockups:
bash .screenshots/generate-mockups.sh
# Capture real screenshots (automated with prompts)
capture-screenshots:
deno run --allow-all .screenshots/capture-screenshots.js
# Optimize screenshot images
optimize-screenshots:
@echo "Optimizing screenshots..."
@for img in .screenshots/*.png; do \
if [ -f "$$img" ]; then \
convert "$$img" -resize '1280x800>' -quality 85 "$$img"; \
echo " ✓ $$(basename $$img)"; \
fi \
done
@echo "✓ Screenshots optimized"
# Full build pipeline
# --------------------
# Complete build: proofs -> build -> lint -> security -> package
full-build: check-proofs build icons lint-ext security-scan build-ext
@echo "✓ Full build complete"
@ls -lh extension/web-ext-artifacts/
# Run panic-attacker pre-commit scan
assail:
@command -v panic-attack >/dev/null 2>&1 && panic-attack assail . || echo "panic-attack not found — install from https://github.com/hyperpolymath/panic-attacker"
# ═══════════════════════════════════════════════════════════════════════════════
# ONBOARDING & DIAGNOSTICS
# ═══════════════════════════════════════════════════════════════════════════════
# Check all required toolchain dependencies and report health
doctor:
#!/usr/bin/env bash
echo "═══════════════════════════════════════════════════"
echo " Fireflag Doctor — Toolchain Health Check"
echo "═══════════════════════════════════════════════════"
echo ""
PASS=0; FAIL=0; WARN=0
check() {
local name="$1" cmd="$2" min="$3"
if command -v "$cmd" >/dev/null 2>&1; then
VER=$("$cmd" --version 2>&1 | head -1)
echo " [OK] $name — $VER"
PASS=$((PASS + 1))
else
echo " [FAIL] $name — not found (need $min+)"
FAIL=$((FAIL + 1))
fi
}
check "just" just "1.25"
check "git" git "2.40"
check "ReScript (resc)" rescript "12.0"
# Optional tools
if command -v panic-attack >/dev/null 2>&1; then
echo " [OK] panic-attack — available"
PASS=$((PASS + 1))
else
echo " [WARN] panic-attack — not found (pre-commit scanner)"
WARN=$((WARN + 1))
fi
echo ""
echo " Result: $PASS passed, $FAIL failed, $WARN warnings"
if [ "$FAIL" -gt 0 ]; then
echo " Run 'just heal' to attempt automatic repair."
exit 1
fi
echo " All required tools present."
# Attempt to automatically install missing tools
heal:
#!/usr/bin/env bash
echo "═══════════════════════════════════════════════════"
echo " Fireflag Heal — Automatic Tool Installation"
echo "═══════════════════════════════════════════════════"
echo ""
if ! command -v just >/dev/null 2>&1; then
echo "Installing just..."
cargo install just 2>/dev/null || echo "Install just from https://just.systems"
fi
echo ""
echo "Heal complete. Run 'just doctor' to verify."
# Guided tour of the project structure and key concepts
tour:
#!/usr/bin/env bash
echo "═══════════════════════════════════════════════════"
echo " Fireflag — Guided Tour"
echo "═══════════════════════════════════════════════════"
echo ""
echo '**Safe Firefox/Gecko flag management for users and developers**'
echo ""
echo "Key directories:"
echo " lib/ Library modules"
echo " docs/ Documentation"
echo " tests/ Test suite"
echo " .github/workflows/ CI/CD workflows"
echo " contractiles/ Must/Trust/Dust contracts"
echo " .machine_readable/ Machine-readable metadata"
echo ""
echo "Quick commands:"
echo " just doctor Check toolchain health"
echo " just heal Fix missing tools"
echo " just help-me Common workflows"
echo " just default List all recipes"
echo ""
echo "Read more: README.adoc, EXPLAINME.adoc"
# Show help for common workflows
help-me:
#!/usr/bin/env bash
echo "═══════════════════════════════════════════════════"
echo " Fireflag — Common Workflows"
echo "═══════════════════════════════════════════════════"
echo ""
echo "FIRST TIME SETUP:"
echo " just doctor Check toolchain"
echo " just heal Fix missing tools"
echo ""
echo "PRE-COMMIT:"
echo " just assail Run panic-attacker scan"
echo ""
echo "LEARN:"
echo " just tour Guided project tour"
echo " just default List all recipes"
# Print the current CRG grade (reads from READINESS.md '**Current Grade:** X' line)
crg-grade:
@grade=$$(grep -oP '(?<=\*\*Current Grade:\*\* )[A-FX]' READINESS.md 2>/dev/null | head -1); \
[ -z "$$grade" ] && grade="X"; \
echo "$$grade"
# Generate a shields.io badge markdown for the current CRG grade
# Looks for '**Current Grade:** X' in READINESS.md; falls back to X
crg-badge:
@grade=$$(grep -oP '(?<=\*\*Current Grade:\*\* )[A-FX]' READINESS.md 2>/dev/null | head -1); \
[ -z "$$grade" ] && grade="X"; \
case "$$grade" in \
A) color="brightgreen" ;; B) color="green" ;; C) color="yellow" ;; \
D) color="orange" ;; E) color="red" ;; F) color="critical" ;; \
*) color="lightgrey" ;; esac; \
echo "[](https://github.com/hyperpolymath/standards/tree/main/component-readiness-grades)"