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.
98 lines
2.3 KiB
Markdown
98 lines
2.3 KiB
Markdown
---
|
|
name: clean-general
|
|
description: Use when writing, fixing, editing, or reviewing Python code quality. Enforces Clean Code's core principles—DRY, single responsibility, clear intent, no magic numbers, proper abstractions.
|
|
---
|
|
|
|
# General Clean Code Principles
|
|
|
|
## Critical Rules
|
|
|
|
**G5: DRY (Don't Repeat Yourself)**
|
|
|
|
Every piece of knowledge has one authoritative representation.
|
|
|
|
```python
|
|
# Bad - duplication
|
|
tax_rate = 0.0825
|
|
ca_total = subtotal * 1.0825
|
|
ny_total = subtotal * 1.07
|
|
|
|
# Good - single source of truth
|
|
TAX_RATES = {"CA": 0.0825, "NY": 0.07}
|
|
def calculate_total(subtotal: float, state: str) -> float:
|
|
return subtotal * (1 + TAX_RATES[state])
|
|
```
|
|
|
|
**G16: No Obscured Intent**
|
|
|
|
Don't be clever. Be clear.
|
|
|
|
```python
|
|
# Bad - what does this do?
|
|
return (x & 0x0F) << 4 | (y & 0x0F)
|
|
|
|
# Good - obvious intent
|
|
return pack_coordinates(x, y)
|
|
```
|
|
|
|
**G23: Prefer Polymorphism to If/Else**
|
|
|
|
```python
|
|
# Bad - will grow forever
|
|
def calculate_pay(employee):
|
|
if employee.type == "SALARIED":
|
|
return employee.salary
|
|
elif employee.type == "HOURLY":
|
|
return employee.hours * employee.rate
|
|
elif employee.type == "COMMISSIONED":
|
|
return employee.base + employee.commission
|
|
|
|
# Good - open/closed principle
|
|
class SalariedEmployee:
|
|
def calculate_pay(self): return self.salary
|
|
|
|
class HourlyEmployee:
|
|
def calculate_pay(self): return self.hours * self.rate
|
|
|
|
class CommissionedEmployee:
|
|
def calculate_pay(self): return self.base + self.commission
|
|
```
|
|
|
|
**G25: Replace Magic Numbers with Named Constants**
|
|
|
|
```python
|
|
# Bad
|
|
if elapsed_time > 86400:
|
|
...
|
|
|
|
# Good
|
|
SECONDS_PER_DAY = 86400
|
|
if elapsed_time > SECONDS_PER_DAY:
|
|
...
|
|
```
|
|
|
|
**G30: Functions Should Do One Thing**
|
|
|
|
If you can extract another function, your function does more than one thing.
|
|
|
|
**G36: Law of Demeter (Avoid Train Wrecks)**
|
|
|
|
```python
|
|
# Bad - reaching through multiple objects
|
|
output_dir = context.options.scratch_dir.absolute_path
|
|
|
|
# Good - one dot
|
|
output_dir = context.get_scratch_dir()
|
|
```
|
|
|
|
## Enforcement Checklist
|
|
|
|
When reviewing AI-generated code, verify:
|
|
- [ ] No duplication (G5)
|
|
- [ ] Clear intent, no magic numbers (G16, G25)
|
|
- [ ] Polymorphism over conditionals (G23)
|
|
- [ ] Functions do one thing (G30)
|
|
- [ ] No Law of Demeter violations (G36)
|
|
- [ ] Boundary conditions handled (G3)
|
|
- [ ] Dead code removed (G9)
|