Gabriel Brown
e1faaf7a76
Phase 6, the last of the fresh-install spec. 159 scripts lose their .sh: 110 contracts, 47 Vicinae commands, 2 compositor contracts. A shebang and the executable bit already select the interpreter. The extension only ever added something that had to stay in sync, and the rename proved the point twice over in the space of an hour. The spec's stated risk was Vicinae's script discovery. One script was renamed and reloaded on its own before the other 46 followed; it came back as scripts:panama.capture and all 47 resolve. What the probe turned up instead is that the extension was never only a filename: Vicinae's command IDs embed it, so every ID changed. Nothing in this repository refers to them, so nothing breaks. The only trace is Vicinae's metadata.json, whose visited map had two Panama entries that are now orphaned -- two commands lost their usage ranking and will earn it back. Worth knowing before anyone renames these again on a machine that has a keybind pointing at one. Rewriting the references by exact filename missed two things it structurally could not see: a name built from a variable, settings-$page.sh, and a glob, -name '*.sh'. Both were in the contract that counts the generated commands, which promptly reported 47 expected and 0 found. The mechanical part of a rename is the part that looks finished. The three subcommands. panama doctor fronts a health check that already existed and already ran at the end of every install but could not be reached from a terminal. panama upgrade re-runs the installer from anywhere. panama test runs the suite, which had no entry point at all -- 121 files that were the main safety net in this repository and were invisible in it. Writing that runner found three tests nothing was running. calendar_agenda_bridge_test, home_assistant_bridge_test and kdeconnect_bridge_test are unittest suites without the executable bit, so no contract invoked them and the first draft of the runner skipped them silently. All three pass, and have passed unobserved for weeks. The runner collects *_test.py as well now, because a runner with a blind spot is worse than no runner for the same reason a dependency checker with one is: it reports PASS. Six worktrees pruned. Each was re-checked rather than trusted to the spec's list, and two needed it: panama-commands is not on feat/panama-commands but on feat/gnome-tweaks-parity, and fix/panama-displays-review reads [ahead 3] -- ahead of its remote, not of main, with every commit patch-equivalent to landed work. roadmap-completion stays; it has five commits that are genuinely unlanded. The branches are left alone: pruning a worktree costs nothing, deleting a branch is a decision. 121 contracts pass. Claude-Session: https://claude.ai/code/session_01NvgBuSWB5sE43yWmg21ozj
61 lines
2.6 KiB
Bash
Executable File
61 lines
2.6 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
# The settings reference is generated, and must not be stale.
|
|
#
|
|
# Every other kind of documentation here has drifted at least once: routing that
|
|
# pointed at a page not containing the setting, contracts that pinned the bug
|
|
# they were meant to prevent, a comment that failed to stop the person who read
|
|
# it from making the exact mistake it described. Prose describing 127 settings
|
|
# would drift the day after it was written.
|
|
#
|
|
# So docs/settings.md is generated from the schema, and this fails the moment
|
|
# the committed copy stops matching. That is the whole mechanism: the document
|
|
# cannot be wrong for longer than it takes to run the suite.
|
|
|
|
set -uo pipefail
|
|
|
|
repo_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
|
generator="$repo_dir/config/dot/quickshell/scripts/panama-settings-docs"
|
|
doc="$repo_dir/docs/settings.md"
|
|
|
|
fail() {
|
|
printf 'settings docs contract: %s\n' "$1" >&2
|
|
exit 1
|
|
}
|
|
|
|
[[ -x "$generator" ]] || fail 'the generator is missing or not executable'
|
|
|
|
"$generator" --check || fail 'docs/settings.md is stale -- run quickshell/scripts/panama-settings-docs and commit the result'
|
|
|
|
# A generator that silently emitted nothing would also pass --check against an
|
|
# equally empty file, so the output is checked for substance too.
|
|
[[ -s "$doc" ]] || fail 'docs/settings.md is empty'
|
|
|
|
settings="$(grep -c '^| \*\*' "$doc")"
|
|
schema_keys="$(grep -c 'key: "' "$repo_dir/config/dot/quickshell/config/PreferenceSchema.qml")"
|
|
|
|
# Internal keys are deliberately omitted, so the document is smaller than the
|
|
# schema -- but not by much. A large gap means the reader stopped recognising
|
|
# entries and quietly documented a fraction of them.
|
|
(( settings > schema_keys * 8 / 10 )) \
|
|
|| fail "the reference documents only $settings of $schema_keys schema keys, which suggests the generator stopped parsing partway"
|
|
|
|
# The compositor-backed settings are the ones worth naming precisely, since
|
|
# that is the string someone would search the Hyprland docs for.
|
|
grep -q 'cursor:zoom_factor' "$doc" \
|
|
|| fail 'compositor option names are missing from the reference'
|
|
|
|
# A stale copy must be detectable, not merely regenerable. Prove the check
|
|
# actually compares content rather than always returning success.
|
|
scratch="$(mktemp -d /tmp/panama-docs.XXXXXX)"
|
|
trap 'rm -rf "$scratch"' EXIT
|
|
cp "$doc" "$scratch/settings.md"
|
|
printf '\n<!-- drift -->\n' >>"$doc"
|
|
if "$generator" --check >/dev/null 2>&1; then
|
|
cp "$scratch/settings.md" "$doc"
|
|
fail '--check reported success on a modified file, so staleness would never be caught'
|
|
fi
|
|
cp "$scratch/settings.md" "$doc"
|
|
|
|
printf 'settings docs contract: PASS (%d settings documented)\n' "$settings"
|