The Canonical API Review skill automates comprehensive code evaluations against foundational API design guidelines. It critically analyzes your codebase for contract decoupling, ergonomic naming, command-query separation (CQS), strict type safety, explicit dependency configuration, and adherence to KISS and YAGNI principles. Ideal for preparation ahead of pull requests or architectural refactors, the skill outputs a structured grading report featuring letter-grade evaluations (A-F), highlighted critical issues, ergonomic suggestions, and actionable before-and-after code diffs.
主要功能
01Delivers concrete before-and-after refactoring code snippets
02Checks interface ergonomics and intent-revealing naming conventions
033,092 GitHub stars
04Evaluates code against canonical API principles like CQS, KISS, and YAGNI
05Generates structured markdown reports with letter grades from A to F
06Audits strict type safety, validation visibility, and explicit dependency injection
使用场景
01Refactoring legacy codebases to enforce explicit dependency injection and strict typing
02Conducting automated pre-PR reviews to catch API design flaws early
03Auditing public SDK or library interfaces before public release