feat: enhance enum handling with functional labels

Author: shijistar

.eslintrc.js

@@ -1,5 +1,8 @@
 module.exports = {
   extends: ['./node_modules/@tiny-codes/code-style-all-in-one/eslint/config/typescript'],
+  parserOptions: {
+    project: ['./tsconfig.eslint.json', './packages/*/tsconfig.json'],
+  },
   settings: {
     'import/resolver': {
       typescript: true,

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 # enum-plus Changelog
 
+## 3.1.5
+
+2025-11-20
+
+### Features
+
+- ✨ Enhance enum creation to support function labels and enum name.
+
+### Bug Fixes
+
+- 🐞 Fix the issue where `enum.meta` is always empty in `meta-only` mode.
+
 ## 3.1.4
 
 2025-11-19

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "enum-plus",
-  "version": "3.1.4",
+  "version": "3.1.5",
   "description": "A drop-in replacement for native enum. Like native enum but much better!",
   "keywords": [
     "enum",
@@ -190,7 +190,7 @@
     "father": "^4.6.3",
     "glob": "^11.1.0",
     "jest": "^29.7.0",
-    "jsoneo": "^1.0.2",
+    "jsoneo": "^1.0.3",
     "npm-run-all2": "^8.0.4",
     "playwright": "^1.55.0",
     "rollup": "^4.50.0",

package.json

@@ -127,6 +127,9 @@ export class EnumCollectionClass<
    *   set.
    */
   get name(): string | undefined {
+    if (typeof this.__options__?.name === 'function') {
+      return this.__options__.name(undefined!);
+    }
     const localize = this.__options__?.localize ?? localizer.localize;
     if (typeof localize === 'function') {
       return localize(this.__options__?.name);

src/enum-collection.ts

@@ -1,5 +1,12 @@
 import { internalConfig, localizer } from './global-config';
-import type { EnumItemInit, EnumKey, EnumValue, LocalizeInterface, ValueTypeFromSingleInit } from './types';
+import type {
+  EnumItemInit,
+  EnumItemLabel,
+  EnumKey,
+  EnumValue,
+  LocalizeInterface,
+  ValueTypeFromSingleInit,
+} from './types';
 import { IS_ENUM_ITEM } from './utils';
 
 /**
@@ -20,7 +27,7 @@ export class EnumItemClass<
   const P = any,
 > {
   private _options: EnumItemOptions<T, K, V, P> | undefined;
-  private _label: string | undefined;
+  private _label: EnumItemLabel | undefined;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private _localize: (content: string | undefined) => any;
 
@@ -34,10 +41,10 @@ export class EnumItemClass<
    * @param raw The original initialization object | 原始初始化对象
    * @param options Optional settings for the enum item | 枚举项的可选设置
    */
-  constructor(key: K, value: V, label: string, raw: T, options?: EnumItemOptions<T, K, V, P>) {
+  constructor(key: K, value: V, label: EnumItemLabel, raw: T, options?: EnumItemOptions<T, K, V, P>) {
     this.key = key;
     this.value = value;
-    this.label = label;
+    this.label = label as string;
     this.raw = raw;
 
     // Should use _label instead of label closure, to make sure it can be serialized correctly
@@ -62,6 +69,10 @@ export class EnumItemClass<
           const labelPrefix = this._options?.labelPrefix;
           const autoLabel = this._options?.autoLabel ?? internalConfig.autoLabel;
           let localeKey = this._label;
+          if (typeof localeKey === 'function') {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            return localeKey(this as any);
+          }
           if (autoLabel && labelPrefix != null) {
             if (typeof autoLabel === 'function') {
               localeKey = autoLabel({

src/enum-item.ts

@@ -3,6 +3,7 @@ import { EnumItemClass } from './enum-item';
 import type {
   EnumInit,
   EnumItemInit,
+  EnumItemLabel,
   EnumKey,
   EnumValue,
   ExactEqual,
@@ -107,7 +108,7 @@ export class EnumItemsArray<
         Object.keys(itemRaw).forEach((k) => {
           const metaKey = k as Exclude<keyof T[keyof T], 'key' | 'value' | 'label'>;
           if (metaKey !== 'key' && metaKey !== 'value' && metaKey !== 'label') {
-            if (!meta[metaKey]) {
+            if (meta[metaKey] == null) {
               meta[metaKey] = [];
             }
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -865,42 +866,42 @@ function parseEnumItem<
   V extends EnumValue,
 >(init: T, key: K): StandardEnumItemInit<V> {
   let value: V;
-  let label: string;
+  let label: EnumItemLabel;
   if (init != null) {
     if (typeof init === 'number' || typeof init === 'string' || typeof init === 'symbol') {
       value = init as V;
-      label = key as string;
+      label = key as EnumItemLabel;
     } else if (typeof init === 'object') {
       // Initialize using object
       if (Object.prototype.toString.call(init) === '[object Object]') {
         if ('value' in init && Object.keys(init).some((k) => k === 'value')) {
           // type of {value, label}
           value = (init.value ?? key) as V;
           if ('label' in init && Object.keys(init).some((k) => k === 'label')) {
-            label = init.label as string;
+            label = init.label!;
           } else {
-            label = key as string;
+            label = key as EnumItemLabel;
           }
         } else if ('label' in init && Object.keys(init).some((k) => k === 'label')) {
           // typeof {label}
           value = key as unknown as V;
-          label = init.label ?? (key as string);
+          label = init.label ?? (key as EnumItemLabel);
         } else {
           // {} empty object
           value = key as unknown as V;
-          label = key as string;
+          label = key as EnumItemLabel;
         }
       } else {
         // Probably Date, RegExp and other primitive types
         value = init as V;
-        label = key as string;
+        label = key as EnumItemLabel;
       }
     } else {
       throw new Error(`Invalid enum item: ${JSON.stringify(init)}`);
     }
   } else {
     value = key as unknown as V;
-    label = key as string;
+    label = key as EnumItemLabel;
   }
   return { value, label };
 }

src/enum-items.ts

@@ -24,6 +24,11 @@ declare module 'enum-plus/extension' {
      *
      * **CN:** 枚举本地化文本的Key值，可以用来增强编辑器的智能提示
      */
-    LocaleKeys: NonNullable<string>;
+    LocaleKeys: // eslint-disable-next-line @typescript-eslint/ban-types
+    | (string & {})
+      | ((
+          // eslint-disable-next-line @typescript-eslint/consistent-type-imports
+          item: import('./enum-item').EnumItemClass<import('./types').StandardEnumItemInit<import('./types').EnumValue>>
+        ) => string | undefined);
   }
 }

src/extension.d.ts

@@ -1,6 +1,6 @@
 import type { EnumLocaleExtends } from 'enum-plus/extension';
 
 export type LocalizeInterface = (
-  localeKey: EnumLocaleExtends['LocaleKeys'] | undefined
+  localeKey: Exclude<EnumLocaleExtends['LocaleKeys'], (...args: any[]) => string | undefined> | undefined
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
 ) => any;

src/localize-interface.ts

@@ -74,6 +74,6 @@ export const IS_ENUM_ITEMS = Symbol.for('[IsEnumItems]');
  *   English, does not provide actual localization functions
  * - **CN:** 默认的全局本地化函数，仅用于将内置资源解析为英文，并不提供实际的本地化功能
  */
-export const defaultLocalize: LocalizeInterface = (content) => {
+export const defaultLocalize: LocalizeInterface = (content): string | undefined => {
   return content;
 };