Naming Convention

Use this guide when naming identifiers — functions, variables, types, files, and directories.

See File Conventions for file placement rules (where to put things). This guide covers what to name them.

1. Identifier Naming

Category Convention Examples
Functions camelCase, verb-first createClient, parseSchemaValue
Classes PascalCase QueryBuilder, FaasBrowserClient
Types / Interfaces PascalCase ServerOptions, DefineApiData
Enums PascalCase (name + members) JobStatus { Pending, Running }
Constants PascalCase ViteConfig, DefaultTimeout
React components PascalCase UserCard, ErrorBoundary
React hooks camelCase, use prefix useUser, useDebounce
React component props PascalCase, suffixed with Props FaasDataWrapperProps
Type guard functions camelCase, is prefix isOperator, isTemplateStringsArray
Generic type params Single uppercase or PascalCase T, TData, TResult

1.1 Abbreviation Rules

Rule Correct Incorrect
Abbreviations at word boundaries parseApiFilenameFromStack parseAPIFilenameFromStack
Common tech terms as words Http, Json, Url, Html, Id HTTP, JSON, URL, HTML, ID
lifecycle as one word lifecycleKey, LifecycleHook lifeCycleKey, LifeCycleHook

1.2 Common Verb Prefixes

Prefix Usage
define* Define API or Job: defineApi, defineJob
create* Factory: createClient, createSplittingContext
get* / set* Accessors: getClient, setMock
parse* / format* Parsing / formatting: parseSchemaValue, formatSchemaError
use* React hooks: useFaas, useStatesRef
is* Type guards / predicates: isOperator, isTypegenInputFile
*Options Config types: ServerOptions, EnqueueJobOptions
*Props React prop types: FaasDataWrapperProps
*Data / *Inject defineApi data / injection types: DefineApiData, DefineApiInject

2. File and Directory Naming

Both directories and files use kebab-case by default, with two exceptions:

Exception Convention Examples
React component PascalCase, matches component name UserCard.tsx → export function UserCard()
React hook camelCase, matches hook name useUser.ts → export function useUser()
DB table file snake_case, mirrors the DB table name user_roles.ts → user_roles table

All other directories and files use kebab-case:

Category Convention Examples
Directories kebab-case load-package/, parse-yaml/
Source files kebab-case query-builder.ts, http-error.ts
Test files kebab-case + .test.ts query-builder.test.ts
Type definition files kebab-case types.ts, server-types.ts

A directory containing a React component uses PascalCase (e.g. ErrorBoundary/), and a directory containing a React hook uses camelCase (e.g. useFaas/). Everything else — utilities, APIs, jobs, services — uses kebab-case.

3. Review Checklist

  • [ ] Functions start with a verb (camelCase)
  • [ ] Types / interfaces / constants are PascalCase
  • [ ] Directories and files use kebab-case (React components/hooks use their own convention, DB table files use snake_case)
  • [ ] Abbreviations follow the word rule: Http, Json, Url, Id
  • [ ] lifecycle is one word, all lowercase