feat: update jsdoc

Author: shijistar

packages/plugin/src/plugins/searchItems.ts

@@ -10,17 +10,15 @@ import type {
 
 export interface PluginOptions {
   /**
-   * **EN:** The name of the field used for list item labels, used to search list items. Default is
-   * `label`.
-   *
-   * **CN:** 列表项标签(名称)的字段名，用于搜索列表项，默认是`label`。
+   * - **EN:** The name of the field used for list item labels, used to search list items. Default is
+   *   `label`.
+   * - **CN:** 列表项标签(名称)的字段名，用于搜索列表项，默认是`label`。
    */
   labelField?: string;
 
   /**
-   * **EN:** Whether to ignore case when searching for list items. Default is `true`.
-   *
-   * **CN:** 搜索列表项时是否忽略大小写，默认是`true`。
+   * - **EN:** Whether to ignore case when searching for list items. Default is `true`.
+   * - **CN:** 搜索列表项时是否忽略大小写，默认是`true`。
    */
   ignoreCase?: boolean;
 }
@@ -90,16 +88,15 @@ declare module 'enum-plus-extend' {
     V extends EnumValue = ValueTypeFromSingleInit<T[K], K>,
   > {
     /**
-     * **EN:** Search for list items, returns true if the item matches the search criteria, false
-     * otherwise. The function supports searching by specific field that is specified in options. If
-     * the search string is empty, it returns all items.
+     * - **EN:** Search for list items, returns true if the item matches the search criteria, false
+     *   otherwise. The function supports searching by specific field that is specified in options.
+     *   If the search string is empty, it returns all items.
      *
-     * This function is compatible with the `Ant Design` specification, and can be as `filterOption`
-     * property of components like `Select`, `AutoComplete`, `Transfer`, `Mentions`, etc.
+     *   This function is compatible with the `Ant Design` specification, and can be as `filterOption`
+     *   property of components like `Select`, `AutoComplete`, `Transfer`, `Mentions`, etc.
+     * - **CN:** 搜索列表项，如果项匹配搜索条件，则返回true，否则返回false。还可以在选项中设置搜索字段，支持按指定的字段进行搜索。如果搜索字符串为空，则返回所有项。
      *
-     * **CN:** 搜索列表项，如果项匹配搜索条件，则返回true，否则返回false。还可以在选项中设置搜索字段，支持按指定的字段进行搜索。如果搜索字符串为空，则返回所有项。
-     *
-     * 该函数兼容`Ant Design`规范，可以作为`Select`、`AutoComplete`、`Transfer`、`Mentions`等组件的`filterOption`属性。
+     *   该函数兼容`Ant Design`规范，可以作为`Select`、`AutoComplete`、`Transfer`、`Mentions`等组件的`filterOption`属性。
      *
      * @param search The search string | 搜索字符串
      * @param item The item to search for | 要搜索的项
@@ -109,15 +106,13 @@ declare module 'enum-plus-extend' {
      */
     searchItems: (
       /**
-       * **EN:** The search string, if empty, return all items
-       *
-       * **CN:** 搜索字符串，如果为空，则返回所有项
+       * - **EN:** The search string, if empty, return all items
+       * - **CN:** 搜索字符串，如果为空，则返回所有项
        */
       search?: string,
       /**
-       * **EN:** The item to search for
-       *
-       * **CN:** 待搜索的列表项
+       * - **EN:** The item to search for
+       * - **CN:** 待搜索的列表项
        */
       item?: V | Record<string, unknown> | EnumItemClass<EnumItemInit<V>, K, V>
     ) => boolean;

packages/plugin/src/plugins/toSelect.ts

@@ -149,31 +149,26 @@ export interface ToSelectConfig<
   V extends EnumValue = ValueTypeFromSingleInit<T[K], K>,
 > {
   /**
-   * **EN:** The name of the value field in the output object, or a function to get the field name,
-   * default is `value`
-   *
-   * **CN:** 输出对象的value字段名，或者获取字段名的函数，默认为 `value`
+   * - **EN:** The name of the value field in the output object, or a function to get the field name,
+   *   default is `value`
+   * - **CN:** 输出对象的value字段名，或者获取字段名的函数，默认为 `value`
    */
   valueField?: FOV;
   /**
-   * **EN:** The name of the label field in the output object, or a function to get the field name,
-   * default is `label`
-   *
-   * **CN:** 输出对象的label字段名，或者获取字段名的函数，默认为 `label`
+   * - **EN:** The name of the label field in the output object, or a function to get the field name,
+   *   default is `label`
+   * - **CN:** 输出对象的label字段名，或者获取字段名的函数，默认为 `label`
    */
   labelField?: FOL;
 }
 
 export interface FirstOptionConfig<V = EnumValue, FOV extends string = string, FOL extends string = string> {
   /**
-   * **EN:** Add a default option at the top
-   *
+   * - **EN:** Add a default option at the top
    * - `true`: the option uses the default value, `value` is `''`, `label` is `'All'`;
    * - `false`: the default option is not added;
    * - `object`: custom default option, must be an object with `key`, `value`, and `label` properties
-   *
-   * **CN:** 在头部添加一个默认选项
-   *
+   * - **CN:** 在头部添加一个默认选项
    * - `true`: 选项使用默认值，`value`为`''`，`label`为`'全部'`
    * - `false`: 不添加默认选项
    * - `object`: 自定义默认选项

src/enum-collection.ts

@@ -21,9 +21,8 @@ import type {
 import { ENUM_COLLECTION, ITEMS, KEYS } from './utils';
 
 /**
- * **EN:** Enum collection extension base class, used to extend the Enums
- *
- * **CN:** 枚举集合扩展基类，用于扩展枚举
+ * - **EN:** Enum collection extension base class, used to extend the Enums
+ * - **CN:** 枚举集合扩展基类，用于扩展枚举
  */
 // @ts-expect-error: because don't know which methods are added
 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
@@ -33,9 +32,8 @@ export class EnumExtensionClass<
   V extends EnumValue = ValueTypeFromSingleInit<T[K], K>,
 > implements EnumExtension<T, K, V> {}
 /**
- * **EN:** Enum collection
- *
- * **CN:** 枚举项集合
+ * - **EN:** Enum collection
+ * - **CN:** 枚举项集合
  */
 export class EnumCollectionClass<
     T extends EnumInit<K, V>,
@@ -49,9 +47,8 @@ export class EnumCollectionClass<
   readonly items!: EnumItemsArray<T, K, V>;
   readonly keys!: K[];
   /**
-   * **EN:** A boolean value indicates that this is an enum collection instance.
-   *
-   * **CN:** 布尔值，表示这是一个枚举集合实例
+   * - **EN:** A boolean value indicates that this is an enum collection instance.
+   * - **CN:** 布尔值，表示这是一个枚举集合实例
    */
   readonly [ENUM_COLLECTION] = true;
   [Symbol.hasInstance](this: EnumCollectionClass<T, K, V>, instance: unknown): boolean {
@@ -66,7 +63,7 @@ export class EnumCollectionClass<
    * a custom `localize` function is set, the return value may vary depending on the implementation
    * of the method.
    *
-   * **CN:** 枚举集合显示名称，支持本地化。注意，通常情况下返回的是字符串，但如果设置了自定义的 `localize` 函数，则返回值可能有所不同，取决于方法的实现
+   * - **CN:** 枚举集合显示名称，支持本地化。注意，通常情况下返回的是字符串，但如果设置了自定义的 `localize` 函数，则返回值可能有所不同，取决于方法的实现
    *
    * @returns {string | undefined} The localized name of the enum collection, or undefined if not
    *   set.

src/enum-item.ts

@@ -16,38 +16,33 @@ export class EnumItemClass<
   V extends EnumValue = ValueTypeFromSingleInit<T, K>,
 > {
   /**
-   * **EN:** The value of the enum item
-   *
-   * **CN:** 枚举项的值
+   * - **EN:** The value of the enum item
+   * - **CN:** 枚举项的值
    */
   readonly value: V;
 
   /**
-   * **EN:** The label of the enum item (also known as display name)
-   *
-   * **CN:** 枚举项的标签（亦称显示名称）
+   * - **EN:** The label of the enum item (also known as display name)
+   * - **CN:** 枚举项的标签（亦称显示名称）
    */
   readonly label: string;
 
   /**
-   * **EN:** The key of the enum item, which is the key in the initialization object when creating
-   * the enum collection.
-   *
-   * **CN:** 枚举项的键，即创建枚举集合时初始化对象中的键
+   * - **EN:** The key of the enum item, which is the key in the initialization object when creating
+   *   the enum collection.
+   * - **CN:** 枚举项的键，即创建枚举集合时初始化对象中的键
    */
   readonly key: K;
 
   /**
-   * **EN:** The original initialization object of the enum item, which is the sub-object of a
-   * single enum item when creating the enum collection.
-   *
-   * **CN:** 枚举项的原始初始化对象，即创建枚举集合时单个枚举项的子对象
+   * - **EN:** The original initialization object of the enum item, which is the sub-object of a
+   *   single enum item when creating the enum collection.
+   * - **CN:** 枚举项的原始初始化对象，即创建枚举集合时单个枚举项的子对象
    */
   readonly raw: T;
   /**
-   * **EN:** A boolean value indicates that this is an enum item instance.
-   *
-   * **CN:** 布尔值，表示这是一个枚举项实例
+   * - **EN:** A boolean value indicates that this is an enum item instance.
+   * - **CN:** 布尔值，表示这是一个枚举项实例
    */
   readonly [ENUM_ITEM] = true;
   /**

src/enum-values.ts

@@ -38,9 +38,8 @@ export class EnumItemsArray<
 {
   private _raw: T;
   /**
-   * **EN:** A boolean value indicates that this is an enum items array.
-   *
-   * **CN:** 布尔值，表示这是一个枚举项数组
+   * - **EN:** A boolean value indicates that this is an enum items array.
+   * - **CN:** 布尔值，表示这是一个枚举项数组
    */
   readonly [ENUM_ITEMS] = true;
 

src/enum.ts

@@ -15,10 +15,9 @@ import { defaultLocalize } from './utils';
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 // let enumExtensions: any;
 /**
- * **EN:** Generate an enum collection, the enum value supports `number` and `string` types, and the
- * enum name supports localization solutions
- *
- * **CN:** 生成一个枚举集合，枚举值支持`number`和`string`类型，枚举名称支持本地化方案
+ * - **EN:** Generate an enum collection, the enum value supports `number` and `string` types, and the
+ *   enum name supports localization solutions
+ * - **CN:** 生成一个枚举集合，枚举值支持`number`和`string`类型，枚举名称支持本地化方案
  *
  * @example
  *   const Week = Enum({
@@ -36,9 +35,8 @@ export function Enum<
   V extends EnumValue = ValueTypeFromSingleInit<T[K], K>,
 >(init: T, options?: EnumInitOptions<T, K, V>): IEnum<T, K, V> & EnumExtension<T, K, V>;
 /**
- * **EN:** Generate an enum based on an object array
- *
- * **CN:** 基于对象数组生成枚举
+ * - **EN:** Generate an enum based on an object array
+ * - **CN:** 基于对象数组生成枚举
  *
  * @example
  *   const Week = Enum([
@@ -72,27 +70,25 @@ export function Enum<
 }
 
 /**
- * **EN:** Global localization function, used to convert enum item text to localized text. Only need
- * to be set once, effective globally. This method need to be set at the project entry, before
- * running any Enum instance
+ * - **EN:** Global localization function, used to convert enum item text to localized text. Only need
+ *   to be set once, effective globally. This method need to be set at the project entry, before
+ *   running any Enum instance
  *
  * If you want to provide a custom localization function, be sure to resolve and localize the
  * following built-in resources:
  *
  * - `enum-plus.options.all` => `All`
- *
- * **CN:** 全局本地化函数，用于把枚举项文本转换为本地化文本。只需要设置一次，全局生效。需要在项目入口处设置，且在运行任何Enum实例之前
+ * - **CN:** 全局本地化函数，用于把枚举项文本转换为本地化文本。只需要设置一次，全局生效。需要在项目入口处设置，且在运行任何Enum实例之前
  *
  * 如果要提供自定义的本地化函数，请务必解析并本地化以下内置资源：
  *
  * - `enum-plus.options.all` => `All`
  */
 Enum.localize = defaultLocalize;
 /**
- * **EN:** Add global extension methods to the enum, and all enum instances will have these new
- * extension methods
- *
- * **CN:** 为枚举增加全局扩展方法，所有枚举实例都会具有这些新扩展方法
+ * - **EN:** Add global extension methods to the enum, and all enum instances will have these new
+ *   extension methods
+ * - **CN:** 为枚举增加全局扩展方法，所有枚举实例都会具有这些新扩展方法
  *
  * @param obj Extension content, must be an object | 扩展内容，必须是一个对象
  */
@@ -103,10 +99,9 @@ Enum.extends = function (obj: Record<string, unknown> | undefined) {
   Object.assign(EnumExtensionClass.prototype, obj);
 };
 /**
- * **EN:** Install a plugin that enhances the functionality of the Enum class by adding new methods
- * or properties.
- *
- * **CN:** 安装一个插件，通过添加新的方法或属性来增强Enum类的功能
+ * - **EN:** Install a plugin that enhances the functionality of the Enum class by adding new methods
+ *   or properties.
+ * - **CN:** 安装一个插件，通过添加新的方法或属性来增强Enum类的功能
  *
  * @param plugin The plugin to install | 要安装的插件
  * @param options The options for the plugin | 插件的选项
@@ -139,10 +134,9 @@ function getInitMapFromArray<
 }
 
 /**
- * **EN:** Represent the Enum plugin that enhances the functionality of the global Enum by adding
- * new methods or properties.
- *
- * **CN:** 表示增强Enum类功能的插件，通过添加新方法或属性
+ * - **EN:** Represent the Enum plugin that enhances the functionality of the global Enum by adding
+ *   new methods or properties.
+ * - **CN:** 表示增强Enum类功能的插件，通过添加新方法或属性
  *
  * @param options The options for the plugin | 插件的选项
  * @param Enum The Enum global method | Enum全局方法

src/extension.d.ts

@@ -1,22 +1,19 @@
 declare module 'enum-plus-extend' {
   /**
-   * **EN:** Global extension of the enumeration, which can be used to add global extension methods
-   *
-   * **CN:** 枚举的全局扩展，可以用来添加全局扩展方法
+   * - **EN:** Global extension of the enumeration, which can be used to add global extension methods
+   * - **CN:** 枚举的全局扩展，可以用来添加全局扩展方法
    */
   // eslint-disable-next-line @typescript-eslint/no-empty-interface, @typescript-eslint/no-unused-vars
   interface EnumExtension<T, K, V> {}
   /**
-   * **EN:** Enum global localization extension
-   *
-   * **CN:** 枚举本地化的全局扩展
+   * - **EN:** Enum global localization extension
+   * - **CN:** 枚举本地化的全局扩展
    */
   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值，可以用来增强编辑器的智能提示
+     * - **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: BuiltInLocaleKeys;
   }