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.
55 lines
1.3 KiB
Markdown
55 lines
1.3 KiB
Markdown
---
|
|
title: Use Noun Phrases for Class Names
|
|
impact: MEDIUM-HIGH
|
|
impactDescription: eliminates 80%+ of "what does this class do" questions
|
|
tags: name, class, noun, identity
|
|
---
|
|
|
|
## Use Noun Phrases for Class Names
|
|
|
|
Class names should be nouns or noun phrases. A class represents a thing or concept. Avoid verbs, manager-style names, and vague words.
|
|
|
|
**Incorrect (verbs, vague, or manager-style):**
|
|
|
|
```java
|
|
// Verb as class name
|
|
class ProcessPayment {}
|
|
|
|
// Vague manager names
|
|
class Manager {}
|
|
class Processor {}
|
|
class Data {}
|
|
class Info {}
|
|
|
|
// Unnecessary suffixes
|
|
class CustomerManager {}
|
|
class AccountProcessor {}
|
|
class PaymentHandler {}
|
|
```
|
|
|
|
**Correct (specific noun phrases):**
|
|
|
|
```java
|
|
// Clear nouns representing entities
|
|
class Payment {}
|
|
class PaymentGateway {}
|
|
|
|
// Specific, descriptive nouns
|
|
class Customer {}
|
|
class WikiPage {}
|
|
class Account {}
|
|
class AddressParser {}
|
|
|
|
// Role-specific names when needed
|
|
class PaymentValidator {} // Validates payments
|
|
class AccountRepository {} // Stores accounts
|
|
```
|
|
|
|
**When NOT to use this pattern:**
|
|
|
|
Manager-style names are acceptable when the class genuinely manages a resource lifecycle:
|
|
- `ConnectionPool` - manages connection lifecycle
|
|
- `ThreadPoolExecutor` - manages thread lifecycle
|
|
|
|
Reference: [Clean Code, Chapter 2: Meaningful Names](https://www.oreilly.com/library/view/clean-code-a/9780136083238/)
|