← ClaudeAtlas

api-consistencylisted

Review component prop interfaces across the design system for naming inconsistencies, missing standard props, and pattern violations. Use when asked to review component APIs, audit prop naming consistency, or check TypeScript interfaces for API inconsistencies.
robritacca-dotcom/design-system · ★ 0 · Web & Frontend · score 66
Install: claude install-skill robritacca-dotcom/design-system
# api-consistency Review component prop interfaces across the design system for naming inconsistencies, missing standard props, and pattern violations. ## When invoked Use this skill when asked to review component APIs, check prop naming consistency, or audit TypeScript interfaces — phrases like "review component APIs", "prop consistency audit", "are our component props consistent", "check for API inconsistencies". ## Instructions 1. **Determine scope.** Accept one of: - A list of specific components (e.g. `Button, CircularButton, ButtonGroup`) → compare those - `all` → scan all components in `src/components/` - A category description (e.g. "all button-like components", "all form inputs") → infer the relevant components 2. **Read every component's TypeScript interface.** Start from `website/src/data/component-api.generated.ts` for the prop inventory — it holds every own prop with type, default, requiredness and description, parsed exactly as the published `.d.ts` documents them. Then read the `.tsx` files in scope for what the generated file does not capture: - The structural contract (`forwardRef`, `{...rest}` placement, the own-props split, `'use client'`) - Default values (from destructuring defaults in the function signature) 3. **First, check conformance to the published contract.** This is the highest-value part of the review and takes precedence over style preferences below. The contract is defined in the `new-component` skill and summarised in CL