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.
40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
---
|
|
title: Use Searchable Names
|
|
impact: HIGH
|
|
impactDescription: enables effective code navigation
|
|
tags: name, searchable, constants, refactoring
|
|
---
|
|
|
|
## Use Searchable Names
|
|
|
|
Single-letter names and numeric constants are hard to locate across a body of text. Longer names trump shorter names, and searchable names trump convenient abbreviations.
|
|
|
|
**Incorrect (unsearchable):**
|
|
|
|
```java
|
|
for (int j = 0; j < 34; j++) {
|
|
s += (t[j] * 4) / 5; // What is 34? What is 4? What is 5?
|
|
}
|
|
```
|
|
|
|
**Correct (searchable and meaningful):**
|
|
|
|
```java
|
|
int realDaysPerIdealDay = 4;
|
|
final int WORK_DAYS_PER_WEEK = 5;
|
|
final int NUMBER_OF_TASKS = 34;
|
|
|
|
int sum = 0;
|
|
for (int taskIndex = 0; taskIndex < NUMBER_OF_TASKS; taskIndex++) {
|
|
int realTaskDays = taskEstimate[taskIndex] * realDaysPerIdealDay;
|
|
int realTaskWeeks = realTaskDays / WORK_DAYS_PER_WEEK;
|
|
sum += realTaskWeeks;
|
|
}
|
|
```
|
|
|
|
Now you can search for `WORK_DAYS_PER_WEEK` and find every place it is used. Try searching for `5` in a large codebase.
|
|
|
|
**Exception:** Single-letter names are acceptable only as local variables in short methods. The length of a name should correspond to the size of its scope.
|
|
|
|
Reference: [Clean Code, Chapter 2: Meaningful Names](https://www.oreilly.com/library/view/clean-code-a/9780136083238/)
|