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.
1.8 KiB
1.8 KiB
title, impact, impactDescription, tags
| title | impact | impactDescription | tags |
|---|---|---|---|
| Avoid Encodings in Names | HIGH | reduces mental translation burden | name, encoding, hungarian, prefixes |
Avoid Encodings in Names
Encoding type or scope information into names adds an extra burden of deciphering. Modern IDEs make Hungarian Notation and member prefixes unnecessary.
Incorrect (encoded type and scope):
// Hungarian Notation - type encoded in name
String strName;
int iAge;
boolean bIsActive;
PhoneNumber phoneString; // Type changed but name wasn't updated!
// Member prefixes
public class Part {
private String m_dsc; // Member description
void setDescription(String dsc) {
m_dsc = dsc;
}
}
// Interface prefix
public interface IShapeFactory {}
Correct (no encodings):
// Let the type system handle types
String name;
int age;
boolean isActive;
PhoneNumber phone;
// No member prefixes - IDE highlights members
public class Part {
private String description;
void setDescription(String description) {
this.description = description;
}
}
// Drop the interface prefix — callers use ShapeFactory, not IShapeFactory
public interface ShapeFactory {}
// Name implementations by what distinguishes them
public class JsonShapeFactory implements ShapeFactory {}
public class SvgShapeFactory implements ShapeFactory {}
// If only one implementation exists, consider whether you need the interface at all
Readers learn to ignore prefixes. You end up seeing only the meaningful part of the name.
Note: ShapeFactoryImpl is a lesser evil than IShapeFactory, but Impl is still an encoding. When possible, name implementations by their distinguishing characteristic (protocol, storage mechanism, algorithm).
Reference: Clean Code, Chapter 2: Meaningful Names