review-component

Review BEEQ StencilJS components against design system standards.

160|24|Updated Feb 22, 2023

Search Tags:#accessibility #components #review #storybook #stenciljs #beeq

Ready to run

npx skills add https://github.com/Endava/BEEQ --skill review-component

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: review-component
Source: https://github.com/Endava/BEEQ/tree/main/.agents/skills/review-component
Command: npx skills add https://github.com/Endava/BEEQ --skill review-component

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you catch design system, accessibility, and implementation issues in BEEQ web components before they reach review or release.

Core Features & Use Cases

Structured Component Review: Evaluates a BEEQ StencilJS component across file structure, naming, JSDoc, props, events, accessibility, styling, tests, and Storybook.
Standards Compliance: Checks the component against BEEQ project conventions and required documentation patterns.
Use Case: Use it when a new or updated bq-* component needs a fast, consistent audit with actionable fixes for PRs, audits, or self-review.

Quick Start

Use the review-component skill to review packages/beeq/src/components/button/bq-button.tsx and return a structured compliance report with required fixes and suggestions.

Frequently Asked Questions about review-component

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

FAQPage Schema

How do I audit a StencilJS component for design system and accessibility compliance?▼

To review a BEEQ component, provide its source, type, style, test, and story files plus BEEQ instruction documents. The review checks structure, naming, documentation, accessibility, styling, tests, and Storybook to produce a structured compliance report.

What does a BEEQ component review check for in a pull request?▼

A bq-* component review verifies section order, prop and event conventions, JSDoc coverage, validation, and test coverage. It evaluates structure, accessibility, styling, and Storybook to ensure full standards compliance for pull requests or pre-submission checks.

Can I use an automated component review for bq-* web components before submission?▼

Yes, automated component review supports bq-* components during pre-submission checks. Supply the component source, type, style, test, and story files plus BEEQ instruction documents to verify conventions and return actionable fixes.

What files do I need to provide to review a BEEQ StencilJS component?▼

Reviewing a BEEQ StencilJS component requires source, type, style, test, and story files plus BEEQ instruction documents. These inputs verify section order, prop and event conventions, JSDoc coverage, validation, and test coverage.

What is the best way to check BEEQ component Storybook documentation and test coverage?▼

The best way to check BEEQ component Storybook and test coverage is a structured review. It evaluates Storybook and tests alongside structure, accessibility, and styling to verify JSDoc coverage and validation meet design system standards.

What are common accessibility and naming convention issues in StencilJS component development?▼

Common StencilJS component issues include missing JSDoc, incorrect prop and event naming, poor section order, and insufficient accessibility validation. A structured review checks these against BEEQ conventions to catch issues before release.