components-auditor

Audit React/TypeScript/Tailwind/Radix components against the shared contract and compliance matrix.

23|4|Updated May 7, 2025
One-click install
npx skills add https://github.com/Stack-and-Flow/design-system --skill components-auditor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: components-auditor
Source: https://github.com/Stack-and-Flow/design-system/tree/main/.atl/skills/components-auditor
Command: npx skills add https://github.com/Stack-and-Flow/design-system --skill components-auditor

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It prevents design-system components from drifting from the shared contract by systematically checking code structure, Storybook conventions, test coverage, visual state completeness, and accessibility requirements before changes ship.

Core Features & Use Cases

  • Component contract enforcement: Verifies the required 6-file pattern, file responsibilities, TypeScript/public prop typing rules, CVA placement, named exports, and token usage consistency.
  • Storybook and testing quality gates: Confirms JSDoc Storybook conventions, disallows unsupported docs configuration, and ensures tests cover hook logic, DOM behavior, ARIA, interaction/keyboard behavior, and disabled states.
  • Visual and accessibility verification: Runs the full visual review protocol (focus/contrast, motion, gradients/transitions, touch target) and ensures reduced motion and accessibility gates are satisfied.

Quick Start

Use the components-auditor skill to review an existing component directory against the component contract, Storybook/test references, and the visual review protocol before submitting a PR.

Frequently Asked Questions about components-auditor

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit React component code quality and accessibility before a PR?

To audit React component quality before a PR, review the component against a shared contract, validate the 6-file structure, check Storybook conventions, run visual states protocols, and verify accessibility expectations like focus and contrast.

What does a component contract audit check in a TypeScript and Tailwind design system?

A component contract audit checks TypeScript prop typing rules, CVA placement, named exports, and Tailwind token usage consistency. It enforces a required 6-file structure and validates specific file responsibilities within the design system.

How do I verify Storybook conventions and test coverage for design system components?

To verify Storybook conventions, check for required JSDoc documentation and disallow unsupported configuration. Confirm test coverage includes hook logic, DOM behavior, ARIA roles, keyboard interaction, and disabled component states.

Can I use a component audit to check visual regression and token usage in Radix components?

Yes, you can use a component audit to review Radix components by validating token usage consistency, running the full visual review protocol for gradients and transitions, and ensuring all visual states and accessibility expectations are met.

What is the best way to enforce a 6-file structure and CVA responsibilities during a delegated review?

The best way to enforce structure during a delegated review is to systematically verify the required 6-file pattern, validate CVA placement and hook responsibilities, and produce a severity-based verdict report using a specified compliance matrix format.