-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Description
Before You File a Proposal Please Confirm You Have Done The Following...
- I have searched for related issues and found none that match my proposal.
- I have searched the current rule list and found no rules that match my proposal.
- I have read the FAQ and my problem is not listed.
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