← Back to list

component-naming
by sgcarstrends
Monorepo for SG Cars Trends backend services
⭐ 14🍴 1📅 Jan 23, 2026
SKILL.md
name: component-naming description: Enforce consistent React component naming conventions using domain + role patterns. Use when creating, reviewing, or refactoring components. allowed-tools: Read, Edit, Write, Grep, Glob
Component Naming Conventions Skill
This skill helps you enforce consistent React component naming conventions across the codebase.
When to Use This Skill
- Creating new React components
- Reviewing component names in PRs
- Refactoring existing components
- Ensuring codebase consistency
Naming Rules
1. PascalCase
All React components use PascalCase:
// ✅ Good
export const TrendChart = () => {};
export const HeroPost = () => {};
// ❌ Bad
export const trendChart = () => {};
export const trend_chart = () => {};
2. Domain + Role Pattern
Combine domain context with component role for clarity:
// ✅ Good - Clear domain and role
export const TrendChart = () => {}; // Trend (domain) + Chart (role)
export const HeroPost = () => {}; // Hero (domain) + Post (role)
export const MetricCard = () => {}; // Metric (domain) + Card (role)
export const LatestCoePremium = () => {}; // LatestCoe (domain) + Premium (role)
// ❌ Bad - Too generic or unclear
export const Chart = () => {}; // No domain context
export const Data = () => {}; // Meaningless
export const Item = () => {}; // No specificity
3. Compound Components for Subparts
Use dot notation for related subcomponents:
// ✅ Good - Compound component pattern
export const HeroPost = () => {};
HeroPost.Image = () => {};
HeroPost.Title = () => {};
HeroPost.Meta = () => {};
// Usage
<HeroPost>
<HeroPost.Image src={...} />
<HeroPost.Title>...</HeroPost.Title>
<HeroPost.Meta date={...} />
</HeroPost>
// ❌ Bad - Flat naming for related components
export const HeroPostImage = () => {};
export const HeroPostTitle = () => {};
export const HeroPostMeta = () => {};
4. Avoid Problematic Suffixes
Never use these suffixes:
// ❌ Avoid these suffixes
export const MetricCardContainer = () => {}; // -Container
export const ChartWrapper = () => {}; // -Wrapper
export const DataComponent = () => {}; // -Component
export const ListElement = () => {}; // -Element
// ✅ Use clear domain + role instead
export const MetricCard = () => {};
export const TrendChart = () => {};
export const RegistrationList = () => {};
5. Avoid Layout/Styling Descriptions
Names should describe purpose, not appearance:
// ❌ Bad - Describes layout/styling
export const LeftSidebar = () => {};
export const BigHeader = () => {};
export const RedButton = () => {};
export const TwoColumnLayout = () => {};
// ✅ Good - Describes purpose
export const NavigationSidebar = () => {};
export const PageHeader = () => {};
export const DangerButton = () => {};
export const ComparisonLayout = () => {};
File Naming Convention
Files use kebab-case matching the component name:
| Component | File Name |
|---|---|
TrendChart | trend-chart.tsx |
HeroPost | hero-post.tsx |
MetricCard | metric-card.tsx |
LatestCoePremium | latest-coe-premium.tsx |
Validation Checklist
When reviewing component names:
- Uses PascalCase
- Has clear domain context (not just "Card", "List", "Item")
- Has clear role (Chart, Card, List, Banner, etc.)
- No -Container, -Wrapper, -Component suffixes
- No layout/styling descriptions (Left, Big, Red, TwoColumn)
- File name matches component in kebab-case
- Related subcomponents use compound pattern
Examples from Codebase
Good patterns found:
TrendAreaChart- Trends domain + Area Chart roleMarketShareDonut- Market Share domain + Donut roleTopMakesChart- Top Makes domain + Chart rolePremiumBanner- Premium domain + Banner roleMetricCard- Metric domain + Card roleLatestCoePremium- Latest COE domain + Premium role
Anti-patterns to avoid:
- Generic names:
Chart,Card,List,Data - Layout names:
LeftPanel,MainContent,TopSection - Suffix pollution:
CardContainer,ListWrapper,ItemComponent
Related Files
apps/web/CLAUDE.md- Web app component conventionsapps/web/src/components/- Web app componentsapps/web/src/app/admin/components/- Admin interface components
Score
Total Score
65/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
✓LICENSE
ライセンスが設定されている
+10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
✓最近の活動
1ヶ月以内に更新
+10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
✓タグ
1つ以上のタグが設定されている
+5
Reviews
💬
Reviews coming soon


