feat: improve type safety in EnumItemLabel

Author: shijistar

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 # enum-plus Changelog
 
+## Unreleased
+
+2025-10-??
+
+### Features
+
+- ✨ Allow extending `EnumItemLabel` type for better type safety and IntelliSense support.
+
 ## 3.0.1
 
 2025-10-6

src/extension.d.ts

@@ -16,13 +16,14 @@ declare module 'enum-plus/extension' {
    *
    * **CN:** 枚举本地化的全局扩展
    */
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface EnumLocaleExtends {
     /**
      * **EN:** Key values of the localized text of the enumeration, which can be used to enhance the
      * intelligent prompt of the editor
      *
      * **CN:** 枚举本地化文本的Key值，可以用来增强编辑器的智能提示
      */
-    LocaleKeys: never;
+    // LocaleKeys: NonNullable<string>;
   }
 }

src/types.ts

@@ -2,6 +2,7 @@ import type { EnumLocaleExtends } from 'enum-plus/extension';
 
 export type { LocalizeInterface } from './localize-interface';
 
+// @ts-expect-error: because LocaleKeys is a user-defined type, so ignore the error here
 export type EnumItemLabel = EnumLocaleExtends['LocaleKeys'] | NonNullable<string>;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -53,11 +54,13 @@ export interface StandardEnumItemInit<V extends EnumValue> {
 }
 export interface ValueOnlyEnumItemInit<V extends EnumValue> {
   value: V;
+  label?: never;
 }
 export interface LabelOnlyEnumItemInit {
   label: EnumItemLabel;
+  value?: never;
 }
-export type CompactEnumItemInit = Record<string, never>; // 等价于{}
+export type CompactEnumItemInit = Record<string, never>; // equivalent to {}
 
 /**
  * - **EN:** Data structure of enumeration item options, used in `toList` method