ZacharyZhang-NY
e74dafcd36
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.
73 lines
2.1 KiB
Markdown
73 lines
2.1 KiB
Markdown
---
|
|
title: Use Vertical Formatting for Readability
|
|
impact: HIGH
|
|
impactDescription: enables scanning code like a newspaper
|
|
tags: fmt, vertical, whitespace, organization
|
|
---
|
|
|
|
## Use Vertical Formatting for Readability
|
|
|
|
Code should read like a newspaper article: headline at the top, details as you go down. Use vertical whitespace to separate concepts. Keep related code close together.
|
|
|
|
**Incorrect (no vertical organization):**
|
|
|
|
```java
|
|
public class WikiPageResponder implements SecureResponder {
|
|
private static final String CONTENT_TYPE = "text/html";
|
|
private WikiPage page;
|
|
private PageData pageData;
|
|
private String pageTitle;
|
|
private Request request;
|
|
private PageCrawler crawler;
|
|
public Response makeResponse(FitNesseContext context, Request request) {
|
|
this.request = request;
|
|
this.page = loadPage();
|
|
if (page == null)
|
|
return notFoundResponse(context, request);
|
|
return makePageResponse(context);
|
|
}
|
|
private WikiPage loadPage() {
|
|
String resource = request.getResource();
|
|
return PageCrawlerImpl.getPageCrawler(context.root).getPage(resource);
|
|
}
|
|
}
|
|
```
|
|
|
|
**Correct (vertical formatting applied):**
|
|
|
|
```java
|
|
public class WikiPageResponder implements SecureResponder {
|
|
|
|
private static final String CONTENT_TYPE = "text/html";
|
|
|
|
private WikiPage page;
|
|
private PageData pageData;
|
|
private String pageTitle;
|
|
private Request request;
|
|
private PageCrawler crawler;
|
|
|
|
public Response makeResponse(FitNesseContext context, Request request) {
|
|
this.request = request;
|
|
this.page = loadPage();
|
|
|
|
if (page == null)
|
|
return notFoundResponse(context, request);
|
|
|
|
return makePageResponse(context);
|
|
}
|
|
|
|
private WikiPage loadPage() {
|
|
String resource = request.getResource();
|
|
return PageCrawlerImpl.getPageCrawler(context.root).getPage(resource);
|
|
}
|
|
}
|
|
```
|
|
|
|
**Guidelines:**
|
|
- Blank lines between concepts (methods, logical sections)
|
|
- Related code grouped together
|
|
- Caller above callee (top-down reading)
|
|
- Variable declarations close to their usage
|
|
|
|
Reference: [Clean Code, Chapter 5: Formatting](https://www.oreilly.com/library/view/clean-code-a/9780136083238/)
|