pippinmole/ghost

public

Source code of Ghost - On Ghost

chore: add the code-review and cleanup skills used for the unslop pass6b064615 days ago192 lines · 12.1 KB

1	---
2	name: thermo-nuclear-code-quality-review
3	description: Run an extremely strict maintainability review for abstraction quality, giant files, and spaghetti-condition growth. Use for a thermo-nuclear code quality review, thermonuclear review, deep code quality audit, or especially harsh maintainability review.
4	disable-model-invocation: true
5	---
6
7	# Thermo-Nuclear Code Quality Review
8
9	Use this skill for an unusually strict review focused on implementation quality, maintainability, abstraction quality, and codebase health.
10
11	Above all, this skill should push the reviewer to be ambitious about code structure. Do not merely identify local cleanup opportunities. Actively search for "code judo" moves: restructurings that preserve behavior while making the implementation dramatically simpler, smaller, more direct, and more elegant.
12
13	## Core Prompt
14
15	Start from this baseline:
16
17	> Perform a deep code quality audit of the current branch's changes.
18	> Rethink how to structure / implement the changes to meaningfully improve code quality without impacting behavior.
19	> Work to improve abstractions, modularity, reduce Spaghetti code, improve succinctness and legibility.
20	> Be ambitious, if there is a clear path to improving the implementation that involves restructuring some of the codebase, go for it.
21	> Be extremely thorough and rigorous. Measure twice, cut once.
22
23	## Non-Negotiable Additional Standards
24
25	Apply the baseline prompt above, plus these explicit review rules:
26
27	0. Be ambitious about structural simplification.
28	- Do not stop at "this could be a bit cleaner."
29	- Look for opportunities to reframe the change so that whole branches, helpers, modes, conditionals, or layers disappear entirely.
30	- Prefer the solution that makes the code feel inevitable in hindsight.
31	- Assume there is often a "code judo" move available: a re-organization that uses the existing architecture more effectively and makes the change dramatically simpler and more elegant.
32	- If you see a path to delete complexity rather than rearrange it, push hard for that path.
33
34	1. Do not let a PR push a file from under 1k lines to over 1k lines without a very strong reason.
35	- Treat this as a strong code-quality smell by default.
36	- Prefer extracting helpers, subcomponents, modules, or local abstractions instead of letting a file sprawl past 1000 lines.
37	- If the diff crosses that threshold, explicitly ask whether the code should be decomposed first.
38	- Only waive this if there is a compelling structural reason and the resulting file is still clearly organized.
39
40	2. Do not allow random spaghetti growth in existing code.
41	- Be highly suspicious of new ad-hoc conditionals, scattered special cases, or one-off branches inserted into unrelated flows.
42	- If a change adds "weird if statements in random places", treat that as a design problem, not a stylistic nit.
43	- Prefer pushing the logic into a dedicated abstraction, helper, state machine, policy object, or separate module instead of tangling an existing path.
44	- Call out changes that make the surrounding code harder to reason about, even if they technically work.
45
46	3. Bias toward cleaning the design, not just accepting working code.
47	- If behavior can stay the same while the structure becomes meaningfully cleaner, push for the cleaner version.
48	- Do not rubber-stamp "it works" implementations that leave the codebase messier.
49	- Strongly prefer simplifications that remove moving pieces altogether over refactors that merely spread the same complexity around.
50
51	4. Prefer direct, boring, maintainable code over hacky or magical code.
52	- Treat brittle, ad-hoc, or "magic" behavior as a code-quality problem.
53	- Be skeptical of generic mechanisms that hide simple data-shape assumptions.
54	- Flag thin abstractions, identity wrappers, or pass-through helpers that add indirection without buying clarity.
55
56	5. Push hard on type and boundary cleanliness when they affect maintainability.
57	- Question unnecessary optionality, `unknown`, `any`
58	- Prefer explicit typed models or shared contracts over loosely-shaped ad-hoc objects.
59	- If a branch relies on silent fallback to paper over an unclear invariant, ask whether the boundary should be made explicit instead.
60
61	6. Keep logic in the canonical layer and reuse existing helpers.
62	- Call out feature logic leaking into shared paths or implementation details leaking through APIs.
63	- Prefer existing canonical utilities/helpers over bespoke one-offs.
64	- Push code toward the right package, service, or module instead of normalizing architectural drift.
65
66	7. Treat unnecessary sequential orchestration and non-atomic updates as design smells when the cleaner structure is obvious.
67	- If independent work is serialized for no good reason, ask whether the flow should run in parallel instead.
68	- If related updates can leave state half-applied, push for a more atomic structure.
69	- Do not over-index on micro-optimizations, but do flag avoidable orchestration complexity that makes the implementation more brittle.
70
71	## Primary Review Questions
72
73	For every meaningful change, ask:
74
75	- Is there a "code judo" move that would make this dramatically simpler?
76	- Can this change be reframed so fewer concepts, branches, or helper layers are needed?
77	- Does this improve or worsen the local architecture?
78	- Did the diff add branching complexity where a better abstraction should exist?
79	- Did a previously cohesive module become more coupled, more stateful, or harder to scan?
80	- Is this logic living in the right file and layer?
81	- Did this change enlarge a file or component past a healthy size boundary?
82	- Are there repeated conditionals that signal a missing model or missing helper?
83	- Is the implementation direct and legible, or does it rely on special cases and incidental control flow?
84	- Is this abstraction actually earning its keep, or is it just a wrapper?
85	- Did the diff introduce casts, optionality, or ad-hoc object shapes that obscure the real invariant?
86	- Is this logic living in the canonical layer, or did the diff leak details across a boundary?
87	- Is this orchestration more sequential or less atomic than it needs to be?
88
89	## What to Flag Aggressively
90
91	Escalate findings when you see:
92
93	- A complicated implementation where a cleaner reframing could delete whole categories of complexity.
94	- Refactors that move code around but fail to reduce the number of concepts a reader must hold in their head.
95	- A file crossing 1000 lines due to the PR, especially if the new code could be split out.
96	- New conditionals bolted onto unrelated code paths.
97	- One-off booleans, nullable modes, or flags that complicate existing control flow.
98	- Feature-specific logic leaking into general-purpose modules.
99	- Generic "magic" handling that hides simple structure and makes the code harder to reason about.
100	- Thin wrappers or identity abstractions that add indirection without simplifying anything.
101	- Unnecessary casts, `any`, `unknown`, or optional params that muddy the real contract.
102	- Copy-pasted logic instead of extracted helpers.
103	- Narrow edge-case handling implemented in the middle of an already busy function.
104	- Refactors that technically pass tests but make the code less modular or less readable.
105	- "Temporary" branching that is likely to become permanent debt.
106	- Bespoke helpers where the codebase already has a canonical utility for the job.
107	- Logic added in the wrong layer/package when it should live somewhere more central.
108	- Sequential async flow where obviously independent work could stay simpler and clearer with parallel execution.
109	- Partial-update logic that leaves state less atomic than necessary.
110
111	## Preferred Remedies
112
113	When you identify a code-quality problem, prefer suggestions like:
114
115	- Delete a whole layer of indirection rather than polishing it.
116	- Reframe the state model so conditionals disappear instead of getting centralized.
117	- Change the ownership boundary so the feature becomes a natural extension of an existing abstraction.
118	- Turn special-case logic into a simpler default flow with fewer exceptions.
119	- Extract a helper or pure function.
120	- Split a large file into smaller focused modules.
121	- Move feature-specific logic behind a dedicated abstraction.
122	- Replace condition chains with a typed model or explicit dispatcher.
123	- Separate orchestration from business logic.
124	- Collapse duplicate branches into a single clearer flow.
125	- Delete wrappers that do not meaningfully clarify the API.
126	- Reuse the existing canonical helper instead of introducing a near-duplicate.
127	- Make type boundaries more explicit so the control flow gets simpler.
128	- Move the logic to the package/module/layer that already owns the concept.
129	- Parallelize independent work when that also simplifies the orchestration.
130	- Restructure related updates into a more atomic flow when partial state would be harder to reason about.
131
132	Do not be satisfied with "maybe rename this" feedback when the real issue is structural.
133	Do not be satisfied with a merely cleaner version of the same messy idea if there is a plausible path to a much simpler idea.
134
135	## Review Tone
136
137	Be direct, serious, and demanding about quality.
138	Do not be rude, but do not soften major maintainability issues into mild suggestions.
139	If the code is making the codebase messier, say so clearly.
140	If the implementation missed an opportunity for a dramatic simplification, say that clearly too.
141
142	Good phrases:
143
144	- `this pushes the file past 1k lines. can we decompose this first?`
145	- `this adds another special-case branch into an already busy flow. can we move this behind its own abstraction?`
146	- `this works, but it makes the surrounding code more spaghetti. let's keep the behavior and restructure the implementation.`
147	- `this feels like feature logic leaking into a shared path. can we isolate it?`
148	- `this abstraction seems unnecessary. can we just keep the direct flow?`
149	- `why does this need a cast / optional here? can we make the boundary more explicit instead?`
150	- `this looks like a bespoke helper for something we already have elsewhere. can we reuse the canonical one?`
151	- `i think there's a code-judo move here that makes this much simpler. can we reframe this so these branches disappear?`
152	- `this refactor moves complexity around, but doesn't really delete it. is there a way to make the model itself simpler?`
153
154	## Output Expectations
155
156	Prioritize findings in this order:
157
158	1. Structural code-quality regressions
159	2. Missed opportunities for dramatic simplification / code-judo restructuring
160	3. Spaghetti / branching complexity increases
161	4. Boundary / abstraction / type-contract problems that make the code harder to reason about
162	5. File-size and decomposition concerns
163	6. Modularity and abstraction issues
164	7. Legibility and maintainability concerns
165
166	Do not flood the review with low-value nits if there are larger structural issues.
167	Prefer a smaller number of high-conviction comments over a long list of cosmetic notes.
168
169	## Approval Bar
170
171	Do not approve merely because behavior seems correct.
172	The bar for approval is:
173
174	- no clear structural regression
175	- no obvious missed opportunity to make the implementation dramatically simpler when such a path is visible
176	- no unjustified file-size explosion
177	- no obvious spaghetti-growth from special-case branching
178	- no obviously hacky or magical abstraction that makes the code harder to reason about
179	- no unnecessary wrapper/cast/optionality churn obscuring the real design
180	- no clear architecture-boundary leak or avoidable canonical-helper duplication
181	- no missed opportunity for an obvious decomposition that would materially improve maintainability
182
183	Treat these as presumptive blockers unless the author can justify them clearly:
184
185	- the PR preserves a lot of incidental complexity when there is a plausible code-judo move that would delete it
186	- the PR pushes a file from below 1000 lines to above 1000 lines
187	- the PR adds ad-hoc branching that makes an existing flow more tangled
188	- the PR solves a local problem by scattering feature checks across shared code
189	- the PR adds an unnecessary abstraction, wrapper, or cast-heavy contract that makes the design more indirect
190	- the PR duplicates an existing helper or puts logic in the wrong layer when there is a clear canonical home
191
192	If those conditions are not met, leave explicit, actionable feedback and push for a cleaner decomposition.