stylistic-refactor
Skill116 starsChanged 7 months agoMITView on GitHub
Project stylistic refactoring rules for Bun/TypeScript CLI. Proactively scans for refactoring opportunities and produces a prioritized plan. Defines the team's preferred coding style.
In this repository6 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- patternsSkill
- prompt-authorSkill
- prompt-evaluateSkill
- structural-refactorSkill
- sync-upstreamSkill
The file
We split this skill into the rules it gives an agent
1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 29
Write the refactoring plan to docs/stylistic-refactor-plan.md (create docs/ if needed).
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Stylistic Refactor
Scan the codebase for opportunities to apply these stylistic preferences. Each style has a reference file with rationale, examples, and exceptions.
Styles
| Style | Rule (one line) | Reference |
| Functions Over Classes | Use top-level functions and plain objects; never introduce classes | details |
| Early Returns | Use guard clauses and early returns; never nest more than 2 levels deep | details |
| Declarative/Imperative Split | Declarative (.map/.filter) for pure transforms; imperative for-loops for side effects | details |
| Immutable First | Create new objects via spread; mutate only caller-owned local data | details |
| Ternary Discipline | Ternaries for simple 2-branch expressions only; if/else for anything complex | details |
| Verb-First Naming | Functions start with verbs; booleans use is/has prefixes | details |
| Concatenation Style | Template literals for multi-line strings; + concatenation for simple joins | details |
Output
Write the refactoring plan to docs/stylistic-refactor-plan.md (create docs/ if needed).
The document should be a prioritized refactoring plan with these sections:
High Value
Implement-ready entries with file:line, current code, target code, and acceptance criteria.
Worth Considering
Valid refactors with moderate impact. Brief entries with file paths and rationale.
Not Worth It
Code that technically violates a style but should NOT be refactored, with explanation why.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.