dotfiles
bugabingas dorkfiles
owned by bugabinga
test(quickshell): reject placeholder comments
4c2e6f20dfce920eaea53a92cca406a86d0c3041
Oliver Jan Krylow <oliver@bugabinga.net> ·
unsigned
Browse filesCompare with HEAD
Changed files (3)
docs/super/inventory/2026-06-17-quickshell-self-contained-audit.md
Modified18 18 - every approved executable boundary is listed in `EXTERNALS.md` with status and reason, and stale unused rows fail.
19 19 - QML imports are limited to Qt, Quickshell, and local `import "."`.
20 20 - every QML component has an early decision comment.
21 +- QML comments do not contain unresolved TODO/stub/placeholder markers; rollout status belongs in inventories.
21 22 - local resource references are audited; currently only bundled `nugu.json` is allowed via `Qt.resolvedUrl`.
22 23 - live/repo path markers such as `../`, `~/.config`, and `~/.local` fail the audit.
23 24 - `quickshell/nugu/nugu.json` exists and matches `hypr/generated/nugu.json`.
quickshell/nugu/README.md
Modified 31 31 `EXTERNALS.md` inventories every approved executable boundary. The audit checks
32 32 that required named-config files are present, every QML component and IPC method
33 33 are documented, QML imports stay local/Qt/Quickshell, every component has an
34 -early decision comment, local resources are audited, the bundled palette matches
34 +early decision comment, QML has no unresolved TODO/stub comments, local resources
35 +are audited, the bundled palette matches
35 36 `hypr/generated/nugu.json`, critical Nugu foreground/background pairs keep at
36 37 least 4.5 contrast, external commands are documented without stale rows, and
37 38 retired companion launchers are not executable dependencies. It intentionally
quickshell/nugu/audit.sh
Modified 77 77 if not any(line.strip().startswith(
"//")
for line
in early)
: 78 78 errors.append(f
"{rel}: missing early decision comment")
80 + for number, line
in enumerate(lines, 1)
: 81 + comment = line.split(
"//", 1)[1] if
"//" in line else
"" 82 + if re.search(r
"\b(TODO|FIXME|XXX|HACK|stub|placeholder)\b", comment, re.I)
: 83 + errors.append(f
"{rel}:{number}: unresolved placeholder comment; document rollout status in inventory instead")
82 87 code_lines.append(line.split(
"//", 1)[0])