Audit the whole tree against the standards #22

New issue

Closed

opened 2026-08-21 21:30:23 +01:00 by joshquinlan · 1 comment

joshquinlan commented

2026-08-21 21:30:23 +01:00

Owner

Every file in the repository read against the global
standards and brought into line, rather than only the parts a
feature happened to touch.

The sweep covers: 72-column wrapping everywhere, the 500-line
ceiling per source file, no nested ifs, opening braces on the
statement line, meaningful names over abbreviations, no magic
numbers, one thing per function, tables in place of repeated
branches, absolute paths over relative hops, shellcheck clean,
set -euo pipefail and early input validation, idempotent
provisioning, and no duplicated source of truth.

Comments get the hardest pass. The default is none: a comment
survives only where the code genuinely cannot be understood
without it, and each one kept is justified explicitly. Anything
that restates what the code does, labels a section, decorates
structure or cites process is deleted. This applies to CI
manifests, configs and scripts as much as to source.

Runs last, after the other open work has landed, so it audits
the tree as it finally stands.

Every file in the repository read against the global standards and brought into line, rather than only the parts a feature happened to touch. The sweep covers: 72-column wrapping everywhere, the 500-line ceiling per source file, no nested ifs, opening braces on the statement line, meaningful names over abbreviations, no magic numbers, one thing per function, tables in place of repeated branches, absolute paths over relative hops, shellcheck clean, set -euo pipefail and early input validation, idempotent provisioning, and no duplicated source of truth. Comments get the hardest pass. The default is none: a comment survives only where the code genuinely cannot be understood without it, and each one kept is justified explicitly. Anything that restates what the code does, labels a section, decorates structure or cites process is deleted. This applies to CI manifests, configs and scripts as much as to source. Runs last, after the other open work has landed, so it audits the tree as it finally stands.

joshquinlan added the

refactor

label

2026-08-21 21:30:23 +01:00

joshquinlan commented

2026-08-21 22:21:37 +01:00

Author

Owner

First pass done across the tree.

The comment standard was already met: of roughly 1,100 comment lines in shell, QML and Lua, almost every one carries a constraint the code cannot (Chromium taking colour only through an enterprise policy, btop rewriting its own config on exit, libadwaita 1.6 moving to CSS variables, Adwaita drawing folders in a fixed blue ramp). The offenders were six section labels: "# Claude Code", "# Go", "# Python", "# w3m" in .bashrc and two lines of Fedora skeleton in .bash_profile.

Also done: three genuinely nested ifs flattened (donbox-idle-profile twice, donbox-monitor-profile once); donbox-monitor-profile was at 493 lines, so the planner moved to lib/monitor-plan.sh leaving 400; over-wide lines wrapped in .bashrc, tmux.sh, remap.lua, fish_prompt.fish and three QML files; and three unnamed unit conversions given names in donbox-nightshift and donbox-ptt. The .bashrc prompt lost a threefold repetition of the truecolour escape to a prompt_colour helper.

Two exceptions taken deliberately: hypr/lua/binds.lua stays aligned past 72 columns, which is now written into the rules, and the tracked CLAUDE.md is left unwrapped as hand-edited prose.

Landed in aff952d and b8df080.

First pass done across the tree. The comment standard was already met: of roughly 1,100 comment lines in shell, QML and Lua, almost every one carries a constraint the code cannot (Chromium taking colour only through an enterprise policy, btop rewriting its own config on exit, libadwaita 1.6 moving to CSS variables, Adwaita drawing folders in a fixed blue ramp). The offenders were six section labels: "# Claude Code", "# Go", "# Python", "# w3m" in .bashrc and two lines of Fedora skeleton in .bash_profile. Also done: three genuinely nested ifs flattened (donbox-idle-profile twice, donbox-monitor-profile once); donbox-monitor-profile was at 493 lines, so the planner moved to lib/monitor-plan.sh leaving 400; over-wide lines wrapped in .bashrc, tmux.sh, remap.lua, fish_prompt.fish and three QML files; and three unnamed unit conversions given names in donbox-nightshift and donbox-ptt. The .bashrc prompt lost a threefold repetition of the truecolour escape to a prompt_colour helper. Two exceptions taken deliberately: hypr/lua/binds.lua stays aligned past 72 columns, which is now written into the rules, and the tracked CLAUDE.md is left unwrapped as hand-edited prose. Landed in aff952d and b8df080.

joshquinlan closed this issue

2026-08-21 22:22:05 +01:00

joshquinlan referenced this issue from a commit

2026-08-21 22:41:35 +01:00

refactor: bring the tree back to the standards

joshquinlan referenced this issue from a commit

2026-08-21 22:41:35 +01:00

refactor: name the unit conversions