Files
AgentCompany/builtin-skills/software-engineer/clean-code/references/fmt-indentation.md
T
ZacharyZhang-NY e74dafcd36 Silence render-disposed spam, unbreak bundled skills, drop board wake
Three independently ugly bugs that all fed the same log flood:

* Electron's `WebFrameMain.send` writes every "Render frame was disposed"
  to stderr via `console.error`. When the worker fans a second
  agent-event past a reloading renderer, we produced thousands of
  identical lines and stalled the main loop on stderr I/O. Added a
  `mainFrame.detached` guard so the send is short-circuited before
  Electron's own catch block fires, and installed a targeted filter in
  `suppress-warnings.ts` (now actually imported from the entry point)
  so the specific `console.error("Error sending from webFrameMain:"…)`
  noise never reaches the terminal. Any other payload still surfaces.

* `dispatchAgentMessage` accepted the human-reader sentinel as a wake
  target when an agent replied to `__board__` — `wakeAgentIfPossible`
  then called `db.getAgent("__board__")`, threw, and the dispatcher
  kept repeating on every send. Strip `HUMAN_SENDER_ID` at
  `resolveMessageWakeTargets`, and keep a defense-in-depth guard in the
  heartbeat so a stray caller (future automation fan-out) cannot
  reintroduce the crash.

* Pi's skills loader rejects any SKILL.md whose frontmatter `name`
  diverges from its parent directory. The four bundled `my-writing-style`
  copies declared `name: writing-style-skill`, so every install emitted
  a warning and dropped the skill. They also lived as orphan gitlinks
  (mode 160000 without .gitmodules), and the global `*.md` gitignore
  hid every other SKILL.md from version control. Fixed the frontmatter
  to match the dir, converted the dangling submodules to plain trees,
  and allowlisted `builtin-skills/**/*.md` so a fresh clone carries the
  catalogue instead of silently losing it.
2026-04-20 08:13:48 -04:00

1.5 KiB

title, impact, impactDescription, tags
title impact impactDescription tags
Respect Indentation Rules MEDIUM preserves visual hierarchy for quick scanning fmt, indentation, hierarchy, structure

Respect Indentation Rules

Indentation makes the scope hierarchy visible. Each level of indentation represents a nested scope. Never collapse short statements onto one line to save space.

Incorrect (collapsed structure):

public class CommentWidget extends TextWidget {
public CommentWidget(ParentWidget parent, String text) { super(parent, text); }
public String render() throws Exception { return ""; }
}

public void process() { for (int i = 0; i < 10; i++) { if (valid(i)) { execute(i); } } }

if (condition) return false; else return true;

Correct (proper indentation):

public class CommentWidget extends TextWidget {

    public CommentWidget(ParentWidget parent, String text) {
        super(parent, text);
    }

    public String render() throws Exception {
        return "";
    }
}

public void process() {
    for (int i = 0; i < 10; i++) {
        if (valid(i)) {
            execute(i);
        }
    }
}

if (condition) {
    return false;
} else {
    return true;
}

Why maintain indentation?

  • Visual scanning relies on indentation
  • Structure is immediately apparent
  • Debugging is easier when scope is visible
  • Merges are cleaner with consistent formatting

Reference: Clean Code, Chapter 5: Formatting