---

name: naming-conventions description: Consistent naming patterns for files, variables, types, and exports

Naming Conventions

Purpose: Consistent, readable naming patterns (improve clarity, maintainability)

• Keywords: naming, variable, function, class, interface, type, const, camelCase, PascalCase, kebab-case, snake_case

Quick Reference

Clear Prefixes

Copy// Functions
function handleSubmit() { }
function getOrderTotal() { }
function isValidEmail() { }
function buildPayload() { }

// Booleans
const isLoading = true
const hasError = false
const canProceed = true
const didComplete = false
const willExpire = true
const shouldRetry = false

Modern Constants

Copyconst bitcoinConfirmations = { mainnet: 3 } as const
const paymentMethods = ["card", "bitcoin"] as const

Avoid Old Patterns

Copy// ❌ ALL_CAPS (outdated)
const MAX_AMOUNT = 100

// ❌ Single-letter generics (complex cases)
function map<T, U>(items: T[]): U[]

// ✅ Descriptive generics
function map<TItem, TResult>(items: TItem[]): TResult[]

Named Exports (Default)

Copy// ✅ Prefer named
export function OrderForm() { }
export const config = { }

// Default only when framework requires (Next.js pages)
export default function Page() { }

Convex Exception

Convex requires snake_case for function files:

Copy// ✅ convex/stripe_webhook.ts
// ✅ convex/bitcoin_mutations.ts

Props Naming

Copyinterface ButtonProps {
  variant: "primary" | "secondary"
  onClick: () => void
}

export function Button({ variant, onClick }: ButtonProps) { }