Skip to content

Rule proposal: Enforce explicit Record<K, V> type annotations for object literals #11410

@marco-carvalho

Description

@marco-carvalho

Before You File a Proposal Please Confirm You Have Done The Following...

My proposal is suitable for this project

  • My proposal specifically checks TypeScript syntax, or it proposes a check that requires type information to be accurate.
  • My proposal is not a "formatting rule"; meaning it does not just enforce how code is formatted (whitespace, brace placement, etc).
  • I believe my proposal would be useful to the broader TypeScript community (meaning it is not a niche proposal).

Description

The rule enforces explicit Record<K, V> type annotations for object literals that have consistent value types (like all strings, numbers, or booleans), transforming implicit typing like const config = { dev: "development", prod: "production" } into explicit typing like const config: Record<'dev' | 'prod', string> = { dev: "development", prod: "production" }. This is useful because explicit Record typing improves type safety by making the intended object structure clear to both TypeScript and developers, enables better IDE support with enhanced autocomplete and refactoring capabilities, makes code more self-documenting by immediately conveying that all values should be of the same type, and helps catch type errors earlier when the object structure is modified - particularly valuable for configuration objects, lookup tables, and mapping objects where consistency is important but might not be obvious from the variable name alone.

Fail Cases

const statusMessages = {
  success: "Operation completed successfully",
  error: "An error occurred", 
  pending: "Operation is in progress",
  cancelled: "Operation was cancelled"
};

Pass Cases

type Status = 'success' | 'error' | 'pending' | 'cancelled';

const statusMessages: Record<Status, string> = {
  success: "Operation completed successfully",
  error: "An error occurred", 
  pending: "Operation is in progress",
  cancelled: "Operation was cancelled"
};

Additional Info

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancement: new plugin ruleNew rule request for eslint-pluginpackage: eslint-pluginIssues related to @typescript-eslint/eslint-plugintriageWaiting for team members to take a look

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy