Skip to content
OpenAgentSkill
Browsing is open · Catalog captured 2026-11-21 · Automatic updates and account services are paused.
Development

typescript-naming

Apply, review, and explain TypeScript naming conventions. Use automatically for tasks involving exports, identifiers, generic type parameters, acronyms, React props and handlers, hooks, comments, or TSDoc.

mkosir · AI review on file

Installation

Read the source and dependencies before running a command. Copying does not install or execute anything.

npx skills add mkosir/typescript-style-guide --skill typescript-naming

About this skill


name: typescript-naming description: Apply, review, and explain TypeScript naming conventions. Use automatically for tasks involving exports, identifiers, generic type parameters, acronyms, React props and handlers, hooks, comments, or TSDoc.

Naming

Apply the TypeScript Style Guide's naming conventions in the context of the current task.

Workflow

  1. Inspect the consuming repository's conventions and configuration.
  2. Let explicit repository conventions take precedence over this opinionated guidance.
  3. Apply, review, or explain only the guidance relevant to the task.
  4. State important tradeoffs when the appropriate name or documentation depends on context or judgment.

Boundaries

  • Keep ESLint and other tooling responsible for checks they can enforce automatically.
  • Do not introduce unrelated TypeScript Style Guide conventions merely because this skill is active.

Related Guidance

Type-Safe Constants With Satisfies

For detailed guidance on validating constants against existing types, use typescript-types when it is available.

Naming

Strive to keep naming conventions consistent and readable, with important context provided, because another person will maintain the code you have written.

Named Export

<Rule prefix="Named exports must be used to ensure that all imports follow a uniform pattern" href="https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-default-export.md"

{export default [ { rules: { 'import/no-default-export': 'error' }, }, // In case of exceptions disable the rule { files: ['src/pages/**/*'], rules: { 'import/no-default-export': 'off' }, }, ]; }

This keeps variable and function names consistent across the entire codebase. Named exports have the benefit of erroring when import statements try to import something that hasn't been declared.

Naming Conventions

While it's often hard to find the best name, aim to optimize code for consistency and future readers by following these conventions:

Variables {#variables-1}

  • Locals
    Camel case
    products, productsFiltered

  • Booleans
    Prefixed with is, has etc.
    isDisabled, hasProduct

  • Constants
    Capitalized

    const FEATURED_PRODUCT_ID = '8f47d2a1-b13e-4d5a-a7d8-6ef1234';
    
  • Object & Array Constants

    Singular, capitalized with const assertion.

    const IDLE_ORDER = {
      pending: 'idle',
      fulfilled: true,
      error: 'Shipping Error',
    } as const;
    
    const DASHBOARD_ACCESS_ROLES = ['admin', 'editor', 'moderator'] as const;
    

    If a type exists, use Type-Safe Constants With Satisfies.

    // Type OrderStatus is predefined (e.g. generated from database schema, API)
    type OrderStatus = {
      pending: 'pending' | 'idle';
      fulfilled: boolean;
      error: string;
    };
    
    const IDLE_ORDER = {
      pending: 'idle',
      fulfilled: true,
      error: 'Shipping Error',
    } as const satisfies OrderStatus;
    
    // Type UserRole is predefined
    type UserRole = 'admin' | 'editor' | 'moderator' | 'viewer' | 'guest';
    
    const DASHBOARD_ACCESS_ROLES = ['admin', 'editor', 'moderator'] as const satisfies ReadonlyArray<UserRole>;
    

Functions {#functions-1}

Camel case
filterProductsByType, formatCurrency

Types {#types-1}

Pascal case
OrderStatus, ProductItem

Generics

A generic type parameter must start with the capital letter T followed by a descriptive name TRequest, TFooBar.

Key reasons and benefits:

  • Complex types often involve generics, for which clear naming improves readability and maintainability.
  • Single-letter generics like T, K, and U are disallowed. The more parameters we introduce, the easier it is to mistake them.
  • Prefixing with T makes it immediately obvious that it's a generic type parameter, not a regular type.
  • A common scenario is when a generic parameter shadows an existing type because it has the same name, e.g. <Request extends Request>.
// ❌ Avoid naming generic parameters with one letter
const createPair = <T, K extends string>(first: T, second: K): [T, K] => {
  return [first, second];
};
const pair = createPair(1, 'a');

// ✅ Use descriptive names starting with capital T
const createPair = <TFirst, TSecond extends string>(first: TFirst, second: TSecond): [TFirst, TSecond] => {
  return [first, second];
};
const pair = createPair(1, 'a');

// ❌ Avoid naming generic parameters without a prefix - which 'Request' is which?
const handle = <Request extends Request>(req: Request): void => {...

// ✅ Prefix generic parameter with capital T
const handle = <TRequest extends Request>(req: TRequest): void => {...

Abbreviations & Acronyms

Treat acronyms as whole words, with capitalized first letter only.

// ❌ Avoid
const FAQList = ['qa-1', 'qa-2'];
const generateUserURL(params) => {...}

// ✅ Use
const Fa
Read the complete source ↗