npx skills add smithery/sgcarstrends --skill component-naming
ruchernchong/blog · Archived
component-naming
Enforces consistent React component naming conventions across the portfolio codebase. Use when creating, reviewing, or refactoring components.
Installation
npx skills add ruchernchong/blog --skill component-naming
Stronger alternatives
This repository is archived — consider an actively maintained alternative.
Maintains visual consistency across portfolio UI components. Use when creating or modifying com…
1 installsConverts Stitch designs into modular Vite and React components using system-level networking an…
50.7K installsGuide for building modern, accessible, and composable UI components. Use when building new comp…
12.5K installsTurn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when…
12.4K installsSimilar popular skills
Related neighbors and high-traction skills in the same topics — useful to compare before installing.
Use when doing ANY task involving Supabase. Triggers: Supabase products (Database, Auth, Edge F…
263K installsAlso in this package
Other skills from ruchernchong/blog.
npx skills add ruchernchong/blog
More details
Agent compatibility
Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.
Also listed on
Alternate registries and mirrors of this skill.
Repository health
main
Skill metadata
Parsed from SKILL.md frontmatter.
Package contents
Files included with this skill beyond the listing page.
-
skill md
SKILL.md5,504 B -
docs
SUMMARY.md166 B
History
- First seen on skills.sh
- First recorded snapshot · 1 installs
SKILL.md
Component Naming Conventions
Use this guide when creating or modifying React components to ensure consistent naming across the portfolio.
Naming Rules
1. PascalCase for Components
All React components use PascalCase:
// ✅ Good
export const FeaturedPost = () => {};
export const TagFilter = () => {};
// ❌ Bad
export const featuredPost = () => {};
export const featured_post = () => {};
2. Domain + Role Pattern
Combine domain context with component role for clarity:
// ✅ Good - Clear domain and role
export const FeaturedPost = () => {}; // Featured (domain) + Post (role)
export const TagFilter = () => {}; // Tag (domain) + Filter (role)
export const ReadingProgress = () => {}; // Reading (domain) + Progress (role)
export const MetricCard = () => {}; // Metric (domain) + Card (role)
export const HeroSection = () => {}; // Hero (domain) + Section (role)
// ❌ Bad - Too generic or unclear
export const Card = () => {}; // No domain context
export const Filter = () => {}; // No specificity
export const Section = () => {}; // Meaningless
3. Compound Components for Subparts
Use dot notation for related subcomponents:
// ✅ Good - Compound component pattern
export const PostCard = () => {};
PostCard.Image = () => {};
PostCard.Title = () => {};
PostCard.Meta = () => {};
// Usage
<PostCard>
<PostCard.Image src={...} />
<PostCard.Title>...</PostCard.Title>
<PostCard.Meta date={...} />
</PostCard>
// ❌ Bad - Flat naming for related components
export const PostCardImage = () => {};
export const PostCardTitle = () => {};
export const PostCardMeta = () => {};
4. Avoid Problematic Suffixes
Never use these suffixes:
// ❌ Avoid these suffixes
export const CardContainer = () => {}; // -Container
export const PostWrapper = () => {}; // -Wrapper
export const DataComponent = () => {}; // -Component
export const ListElement = () => {}; // -Element
// ✅ Use clear domain + role instead
export const MetricCard = () => {};
export const PostList = () => {};
export const TagBadge = () => {};
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 TwoColumnGrid = () => {};
// ✅ Good - Describes purpose
export const NavigationSidebar = () => {};
export const PageHeader = () => {};
export const DangerButton = () => {};
export const BentoGrid = () => {};
File Naming Convention
Files use kebab-case matching the component name:
| Component | File Name |
|---|---|
FeaturedPost |
featured-post.tsx |
TagFilter |
tag-filter.tsx |
ReadingProgress |
reading-progress.tsx |
MetricCard |
metric-card.tsx |
HeroSection |
hero-section.tsx |
Component Location
| Location | Purpose |
|---|---|
src/components/ |
Reusable components |
src/components/auth/ |
Authentication components |
src/app/components/ |
App-level shared components |
src/app/(main)/about/components/ |
About page components |
src/app/(main)/blog/components/ |
Blog page components |
src/app/(main)/dashboard/components/ |
Dashboard page components |
src/app/studio/media/components/ |
Studio media components |
src/app/studio/posts/components/ |
Studio posts components |
src/app/studio/series/components/ |
Studio series components |
Validation Checklist
When reviewing component names:
- Uses PascalCase
- Has clear domain context (not just "Card", "List", "Item")
- Has clear role (Chart, Card, List, Section, Filter, 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 for Blog Redesign
Good patterns:
| Component | Domain | Role |
|---|---|---|
FeaturedPost |
Featured | Post |
TagFilter |
Tag | Filter |
ReadingProgress |
Reading | Progress |
PostGrid |
Post | Grid |
AuthorCard |
Author | Card |
BentoGrid |
Bento | Grid |
HeroSection |
Hero | Section |
LatestPosts |
Latest | Posts |
SkillsGrid |
Skills | Grid |
ContactCta |
Contact | Cta |
Anti-patterns to avoid:
- Generic names:
Card,Grid,List,Section - Layout names:
LeftPanel,MainContent,TopSection - Suffix pollution:
CardContainer,ListWrapper,PostComponent
Related Files
.claude/skills/design-language-system/SKILL.md- Design system guidelinessrc/components/- Blog components