Skip to content

fix(canon): deed_canon ignores inline ";" comments #1136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hyperpolymath merged 1 commit into from
Oct 2, 2026
Merged

fix(canon): deed_canon ignores inline ";" comments #1136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions scripts/check-canon-lockstep.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,11 +269,12 @@ echo

# deed_canon <key> <deed-file>: print the value of :<key> from the
# deed's one (canon …) clause, or nothing when the clause or key is
# absent or the clause is not unique. The SAME function is in
# absent or the clause is not unique. A ";" outside a string starts a
# comment that runs to line-end (deed.abnf), whole-line or inline. The SAME function is in
# rsr-template-repo .github/workflows/dogfood-gate.yml and
# build/just/repo-init.just; keep the three identical.
deed_canon() {
_clauses="$(grep -vE '^[[:space:]]*;' "$2" | awk '{ printf "%s ", $0 }' | grep -oE '[(]canon[[:space:]][^()]*[)]')" || true
_clauses="$(awk 'BEGIN { bs = sprintf("%c", 92); dq = sprintf("%c", 34) } { o = ""; q = 0; for (i = 1; i <= length($0); i++) { c = substr($0, i, 1); if (q && c == bs) { o = o c substr($0, i + 1, 1); i++; continue } if (c == dq) q = !q; else if (!q && c == ";") break; o = o c } printf "%s ", o }' "$2" | grep -oE '[(]canon[[:space:]][^()]*[)]')" || true
_n="$(echo "$_clauses" | grep -c '(canon' || true)"
if [ "$_n" != "1" ]; then
echo "deed_canon: $2 carries ${_n:-0} (canon …) clauses, need exactly 1" >&2
Expand Down
10 changes: 10 additions & 0 deletions scripts/tests/check-canon-lockstep-deed-test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,16 @@ mkdir -p "$WORK/two-deeds"; deed "$WORK/two-deeds" "$WANT_VER" "$WANT_CRIT" "$WA
cp "$WORK/two-deeds/spine_chora.deed" "$WORK/two-deeds/other_chora.deed"
expect "two deeds fail" "$WORK/two-deeds" FAIL "one-deed-per-repo"

# An inline comment (deed.abnf: ";" to line-end, anywhere outside a string)
# is not part of the clause: a decoy :version there must never be read.
deed "$WORK/inline-stale" "0.0.1" "$WANT_CRIT" "$WANT_GATES"
sed -i 's/^ (canon$/ (canon ; :version "'"$WANT_VER"'"/' "$WORK/inline-stale/spine_chora.deed"
expect "inline-comment decoy cannot mask a stale version" "$WORK/inline-stale" FAIL "(version)"

deed "$WORK/inline-ok" "$WANT_VER" "$WANT_CRIT" "$WANT_GATES"
sed -i 's/^ (canon$/ (canon ; :version "0.0.1" -- a ";" here too/' "$WORK/inline-ok/spine_chora.deed"
expect "inline-comment decoy is ignored when the active pin matches" "$WORK/inline-ok" PASS

mkdir -p "$WORK/legacy/.machine_readable"
printf '[canon]\nversion = "0.0.1"\ncriteria_sha256 = "%s"\n' "$WANT_CRIT" > "$WORK/legacy/.machine_readable/rsr-profile.a2ml"
expect "legacy a2ml fallback still passes on criteria" "$WORK/legacy" PASS "LEGACY"
Expand Down
Loading