commit 76475ed2740b6e36f6ab3856e1eccf5686e53e32 Author: Zhongwei Li Date: Sat Nov 29 18:47:03 2025 +0800 Initial commit diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json new file mode 100644 index 0000000..949c838 --- /dev/null +++ b/.claude-plugin/plugin.json @@ -0,0 +1,12 @@ +{ + "name": "ui-library-usage-auditor", + "description": "This skill should be used when reviewing shadcn/ui component usage to ensure accessibility, consistency, and proper patterns. Applies when auditing UI code, checking component patterns, reviewing layout structure, identifying component extraction opportunities, or ensuring design system compliance. Trigger terms include audit UI, review components, check shadcn, accessibility audit, component review, UI patterns, design system compliance, layout review, refactor components, extract component.", + "version": "1.0.0", + "author": { + "name": "Hope Overture", + "email": "support@worldbuilding-app-skills.dev" + }, + "skills": [ + "./skills" + ] +} \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..9d360c8 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# ui-library-usage-auditor + +This skill should be used when reviewing shadcn/ui component usage to ensure accessibility, consistency, and proper patterns. Applies when auditing UI code, checking component patterns, reviewing layout structure, identifying component extraction opportunities, or ensuring design system compliance. Trigger terms include audit UI, review components, check shadcn, accessibility audit, component review, UI patterns, design system compliance, layout review, refactor components, extract component. diff --git a/plugin.lock.json b/plugin.lock.json new file mode 100644 index 0000000..1d973ee --- /dev/null +++ b/plugin.lock.json @@ -0,0 +1,49 @@ +{ + "$schema": "internal://schemas/plugin.lock.v1.json", + "pluginId": "gh:hopeoverture/worldbuilding-app-skills:plugins/ui-library-usage-auditor", + "normalized": { + "repo": null, + "ref": "refs/tags/v20251128.0", + "commit": "28c17e127626c95550e54fe5a49e06a1e813f934", + "treeHash": "10b450e2c724f28c8ce8a87bc2c8b4ad9f62ea91000b2022a364c38c48f6f658", + "generatedAt": "2025-11-28T10:17:34.557187Z", + "toolVersion": "publish_plugins.py@0.2.0" + }, + "origin": { + "remote": "git@github.com:zhongweili/42plugin-data.git", + "branch": "master", + "commit": "aa1497ed0949fd50e99e70d6324a29c5b34f9390", + "repoRoot": "/Users/zhongweili/projects/openmind/42plugin-data" + }, + "manifest": { + "name": "ui-library-usage-auditor", + "description": "This skill should be used when reviewing shadcn/ui component usage to ensure accessibility, consistency, and proper patterns. Applies when auditing UI code, checking component patterns, reviewing layout structure, identifying component extraction opportunities, or ensuring design system compliance. Trigger terms include audit UI, review components, check shadcn, accessibility audit, component review, UI patterns, design system compliance, layout review, refactor components, extract component.", + "version": "1.0.0" + }, + "content": { + "files": [ + { + "path": "README.md", + "sha256": "6380f5bc4ddb3ba9e03435e12a8b5092f3f727fd2c3aafeea2b374e5ef9edd64" + }, + { + "path": ".claude-plugin/plugin.json", + "sha256": "ff40dfe4c6ec2b1ddb53514e95ed95d77ea4fd389a52c0d8b5783ac9d88e06e1" + }, + { + "path": "skills/ui-library-usage-auditor/SKILL.md", + "sha256": "0c1948442b4755b309b4ee1f71f25e7b7d848f056970a2dbbd127b452cfeb175" + }, + { + "path": "skills/ui-library-usage-auditor/references/audit-checklist.md", + "sha256": "aada711b275bb497f231a05e9a703ca2cfd5194256c55d628988a8de4a59f86c" + } + ], + "dirSha256": "10b450e2c724f28c8ce8a87bc2c8b4ad9f62ea91000b2022a364c38c48f6f658" + }, + "security": { + "scannedAt": null, + "scannerVersion": null, + "flags": [] + } +} \ No newline at end of file diff --git a/skills/ui-library-usage-auditor/SKILL.md b/skills/ui-library-usage-auditor/SKILL.md new file mode 100644 index 0000000..22120aa --- /dev/null +++ b/skills/ui-library-usage-auditor/SKILL.md @@ -0,0 +1,599 @@ +--- +name: ui-library-usage-auditor +description: This skill should be used when reviewing shadcn/ui component usage to ensure accessibility, consistency, and proper patterns. Applies when auditing UI code, checking component patterns, reviewing layout structure, identifying component extraction opportunities, or ensuring design system compliance. Trigger terms include audit UI, review components, check shadcn, accessibility audit, component review, UI patterns, design system compliance, layout review, refactor components, extract component. +allowed-tools: Read, Grep, Glob, Bash +--- + +# UI Library Usage Auditor + +Review and audit shadcn/ui component usage across the codebase to ensure accessible, consistent, and maintainable UI patterns. This skill identifies issues, suggests improvements, and recommends component extractions or layout optimizations. + +## When to Use This Skill + +Apply this skill when: +- Auditing UI components for accessibility compliance +- Reviewing shadcn/ui usage patterns for consistency +- Identifying opportunities for component extraction +- Checking layout structure and responsive design +- Ensuring proper ARIA attributes and semantic HTML +- Finding duplicate component patterns +- Reviewing form implementations +- Checking for proper error handling in UI +- Validating design system adherence + +## Audit Categories + +### 1. Accessibility Audit + +Check for: +- Missing ARIA labels and descriptions +- Improper heading hierarchy +- Missing alt text on images +- Insufficient color contrast +- Missing keyboard navigation support +- Form fields without labels +- Non-semantic HTML usage +- Missing focus indicators +- Improper button vs link usage +- Missing skip links for navigation + +### 2. Component Consistency Audit + +Check for: +- Inconsistent component variants across pages +- Mixed styling approaches (inline vs className) +- Duplicate component implementations +- Inconsistent spacing patterns +- Mixed icon libraries or icon sizes +- Inconsistent typography usage +- Non-standard button patterns +- Inconsistent error message displays +- Mixed loading state implementations + +### 3. Component Extraction Opportunities + +Identify: +- Repeated component patterns (3+ instances) +- Complex inline JSX that could be components +- Reusable form field groups +- Common layout patterns +- Shared modal/dialog content +- Repeated table structures +- Common card layouts +- Shared empty states +- Repeated loading skeletons + +### 4. Layout and Responsiveness + +Review: +- Responsive breakpoint usage +- Container max-width consistency +- Grid and flexbox usage patterns +- Mobile-first responsive design +- Overflow handling +- Scroll behavior +- Fixed positioning issues +- Z-index management + +### 5. shadcn/ui Best Practices + +Verify: +- Correct component imports from @/components/ui +- Proper use of composition patterns +- Correct variant prop usage +- Proper form component structure +- Correct dialog/modal patterns +- Proper toast/notification usage +- Appropriate dropdown/select usage +- Correct table implementations + +## Audit Process + +### Step 1: Scan Codebase for Components + +Use Glob to identify all component files: + +```bash +# Find all component files +Glob: **/*.tsx +Glob: app/**/*.tsx +Glob: components/**/*.tsx +``` + +### Step 2: Grep for Specific Patterns + +Search for common patterns and potential issues: + +```bash +# Find form implementations +Grep: pattern=" setName(e.target.value)} +/> +``` + +**Solution:** +```tsx + ( + + Name + + + + + + )} +/> +``` + +### Issue 2: Div as Button + +**Problem:** +```tsx +
+ Click me +
+``` + +**Solution:** +```tsx + +``` + +### Issue 3: Missing Image Alt Text + +**Problem:** +```tsx + +``` + +**Solution:** +```tsx +User profile avatar +``` + +### Issue 4: Inconsistent Spacing + +**Problem:** +```tsx +// File 1 +
+ +// File 2 +
+ +// File 3 +
+``` + +**Solution:** +```tsx +// Standardize spacing scale +
// Use consistent gap values (2, 4, 6, 8) +``` + +### Issue 5: Complex Inline Component + +**Problem:** +```tsx +// Repeated in multiple files + + +
+
+ + + {user.initials} + +
+ {user.name} + {user.role} +
+
+ + {/* Menu items */} + +
+
+
+``` + +**Solution:** +Extract to reusable component: +```tsx +// components/UserCard.tsx +export function UserCard({ user }: UserCardProps) { + return ( + + +
+
+ + + {user.initials} + +
+ {user.name} + {user.role} +
+
+ +
+
+
+ ) +} +``` + +### Issue 6: Improper Heading Hierarchy + +**Problem:** +```tsx +
+

Dashboard

+
+

Recent Activity

{/* Skipped h2 */} +
+
+``` + +**Solution:** +```tsx +
+

Dashboard

+
+

Recent Activity

{/* Proper hierarchy */} +
+
+``` + +### Issue 7: Missing Loading States + +**Problem:** +```tsx + +``` + +**Solution:** +```tsx + +``` + +### Issue 8: Inconsistent Error Display + +**Problem:** +```tsx +// Mixing different error patterns +{error &&

{error}

} +{error && {error}} +{error && {error}} +``` + +**Solution:** +```tsx +// Standardize on Alert component +{error && ( + + + {error} + +)} +``` + +## Audit Report Template + +Generate audit reports using this structure: + +```markdown +# UI Library Usage Audit Report + +**Generated:** [Date] +**Scope:** [Files/directories audited] +**Total Components Reviewed:** [Count] + +## Executive Summary + +[Brief overview of findings and overall code health] + +## Critical Issues (Must Fix) + +### 1. Accessibility Violations + +- **Issue:** Missing alt text on images + - **Files:** `app/characters/[id]/page.tsx:45`, `components/CharacterCard.tsx:23` + - **Fix:** Add descriptive alt attributes to all images + - **Priority:** High + +- **Issue:** Form inputs without labels + - **Files:** `app/create-location/page.tsx:78` + - **Fix:** Wrap inputs in FormField with FormLabel + - **Priority:** High + +### 2. Broken Patterns + +- **Issue:** Divs used as buttons with onClick handlers + - **Files:** `components/Navigation.tsx:34`, `app/timeline/page.tsx:102` + - **Fix:** Replace with Button component + - **Priority:** High + +## Warnings (Should Fix) + +### 1. Inconsistent Patterns + +- **Issue:** Mixed spacing scales (gap-2, gap-3, gap-4, space-x-2) + - **Occurrences:** 47 instances across 23 files + - **Recommendation:** Standardize on gap-{2,4,6,8} scale + - **Priority:** Medium + +- **Issue:** Inconsistent loading states + - **Files:** `app/characters/actions.ts`, `app/locations/actions.ts` + - **Recommendation:** Create shared LoadingButton component + - **Priority:** Medium + +### 2. Component Duplication + +- **Issue:** Character card pattern repeated 5 times + - **Files:** Multiple files listed + - **Recommendation:** Extract CharacterCard component + - **Priority:** Medium + +## Suggestions (Consider) + +### 1. Component Extraction Opportunities + +#### EntityCard Component +**Occurrences:** 8 similar patterns +**Files:** +- `app/characters/page.tsx:67-89` +- `app/locations/page.tsx:54-76` +- `app/items/page.tsx:43-65` + +**Proposed Component:** +```tsx +interface EntityCardProps { + title: string + description: string + image?: string + tags?: string[] + actions?: ReactNode +} + +export function EntityCard({ ... }: EntityCardProps) { + // Unified card implementation +} +``` + +#### FormSection Component +**Occurrences:** 12 similar patterns +**Recommendation:** Extract reusable form section with heading and fields + +### 2. Layout Improvements + +- **Issue:** Inconsistent container max-width + - **Recommendation:** Use standard container classes + - **Files:** Multiple page components + +- **Issue:** Missing responsive breakpoints + - **Recommendation:** Add mobile-first responsive design + - **Files:** `app/timeline/page.tsx`, `components/WorldMap.tsx` + +## shadcn/ui Best Practices + +### Correct Usage [OK] + +- [OK] Forms using FormField pattern (23 components) +- [OK] Proper Button variants (89 instances) +- [OK] Consistent Dialog usage (14 components) + +### Needs Improvement + +- Use Card composition (found 7 instances using raw divs) +- Use Table component instead of custom tables (3 instances) +- Replace custom dropdowns with DropdownMenu (4 instances) + +## Accessibility Score + +**Overall Score:** 72/100 + +- **Semantic HTML:** 85/100 +- **ARIA Attributes:** 65/100 +- **Keyboard Navigation:** 78/100 +- **Focus Management:** 70/100 +- **Color Contrast:** 88/100 + +## Recommendations Priority + +1. **Immediate (This Week)** + - Fix missing alt text on images + - Add labels to all form inputs + - Replace div buttons with Button component + +2. **Short-term (This Month)** + - Extract repeated CharacterCard pattern + - Standardize loading state patterns + - Standardize spacing scale + +3. **Long-term (This Quarter)** + - Implement comprehensive component library documentation + - Create storybook for all shared components + - Establish component extraction guidelines + +## Metrics + +- **Total Files Scanned:** 127 +- **Components Reviewed:** 89 +- **Issues Found:** 34 critical, 67 warnings, 45 suggestions +- **Average Component Complexity:** Medium +- **Code Duplication Score:** 23% (target: <15%) + +## Next Steps + +1. Create GitHub issues for critical accessibility violations +2. Schedule team review of component extraction opportunities +3. Update style guide with standardized patterns +4. Plan refactoring sprint for high-priority warnings +``` + +## Automation with Scripts + +Use references/audit-checklist.md for comprehensive checklist of items to verify during audit. + +## Best Practices for Auditing + +1. **Start Broad, Then Focus**: Begin with file scanning, then drill into specific issues +2. **Prioritize by Impact**: Accessibility issues > Broken patterns > Inconsistencies > Optimizations +3. **Provide Context**: Include file paths, line numbers, and code snippets +4. **Suggest Solutions**: Don't just identify problems, provide concrete fixes +5. **Quantify Issues**: Use metrics to show scope and track improvement +6. **Group Related Issues**: Cluster similar problems for efficient fixing +7. **Consider User Impact**: Prioritize issues affecting end-user experience +8. **Balance Perfection vs Pragmatism**: Focus on high-value improvements + +## Common Grep Patterns for Auditing + +```bash +# Find potential accessibility issues +Grep: pattern="]*alt=)" output_mode="files_with_matches" +Grep: pattern="onClick.*<(div|span)" output_mode="content" +Grep: pattern="]*aria-label)" output_mode="content" + +# Find inconsistent patterns +Grep: pattern="className=\"[^\"]*gap-[13579]" output_mode="count" +Grep: pattern="style=" output_mode="files_with_matches" + +# Find component usage +Grep: pattern="from ['\"]@/components/ui" output_mode="content" +Grep: pattern="200 lines) +- Inconsistent empty states +- Missing TypeScript types +- Inconsistent naming conventions + +### Low Priority (Nice to Have) +- Component extraction opportunities (2 instances) +- Minor styling inconsistencies +- Missing JSDoc comments +- Optimization opportunities + +## Audit Report Sections + +Include in final report: +1. Executive Summary +2. Critical Issues (with file paths and line numbers) +3. Warnings (grouped by category) +4. Suggestions (component extractions, refactoring) +5. Metrics (files scanned, issues found, accessibility score) +6. Best Practices Adherence +7. Recommendations Priority +8. Next Steps