What problem does it solve?
Provides pragmatic coding standards and actionable rules to prevent over-engineering, unclear names, large functions, and unnecessary comments so that code is easier to read, maintain, and safely modify.
Core Features & Use Cases
- Practical Rules: Enforces single responsibility, small functions, one level of abstraction, limited arguments, guard clauses, and meaningful naming.
- Operational Guardrails: Requires thinking through imports, dependencies, tests, and co-editing dependent files before making changes.
- Verification Workflow: Safer change process with mandatory self-checks and running designated verification scripts; maps agents to allowed scripts to avoid cross-role mistakes.
- Use Case: Refactor a tangled UserService to split responsibilities, rename confusing identifiers, and run lint/test verification before marking the task complete.
Quick Start
Apply the clean-code rules to refactor UserService.ts to reduce complexity, rename unclear identifiers, and run any available verification scripts to confirm no regressions.