feat: 新增 setUpdatePerformanceListener 类型 & lint hook (#25)

Co-authored-by: 小翊 <[email protected]>
Co-authored-by: temu.psc <[email protected]>

Author: 3 people

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

package.json

@@ -13,14 +13,24 @@
     "disttag:release": "sh ./scripts/set-release-tag.sh",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
     "test": "jest",
-    "ci": "yarn test"
+    "ci": "yarn test",
+    "lint": "prettier -w .",
+    "prepare": "husky install"
+  },
+  "lint-staged": {
+    "*.d.ts": [
+      "prettier --config ./.prettierrc --write"
+    ]
   },
   "devDependencies": {
     "@tsd/typescript": "^4.7.4",
     "conventional-changelog-cli": "^2.2.2",
+    "husky": "^8.0.3",
     "jest": "^28.1.1",
     "jest-runner-tsd": "^3.1.0",
     "lerna": "^5.0.0",
+    "lint-staged": "^13.1.0",
+    "prettier": "^2.8.1",
     "typescript": "^4.6.4"
   }
 }

packages/global/types/index.d.ts

@@ -33,9 +33,9 @@ declare namespace MiniProgram {
   type TGetMixinProps<T> = T extends { props: infer P } ? P : never;
 
   // 整合一下类型
-  type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (
-    x: infer R
-  ) => any
+  type UnionToIntersection<T> = (
+    T extends any ? (x: T) => any : never
+  ) extends (x: infer R) => any
     ? R
     : never;
 
@@ -54,14 +54,14 @@ declare namespace MiniProgram {
    * Recursively map a type and make all properties optional & dynamic.
    */
   type RecursivePartialAndDynamic<T> = T extends object
-  ? {
-      [P in keyof T]?: T[P] extends Array<infer U>
-        ? Array<RecursivePartialAndDynamic<U>>
-        : T[P] extends Function
-        ? T[P]
-        : T[P] extends object
-        ? RecursivePartialAndDynamic<T[P]>
-        : T[P];
-    }
-  : T;
+    ? {
+        [P in keyof T]?: T[P] extends Array<infer U>
+          ? Array<RecursivePartialAndDynamic<U>>
+          : T[P] extends Function
+          ? T[P]
+          : T[P] extends object
+          ? RecursivePartialAndDynamic<T[P]>
+          : T[P];
+      }
+    : T;
 }

packages/global/types/lib.app.d.ts

@@ -90,9 +90,7 @@ declare namespace MiniProgram.App {
   /**
    * Additional properties in App instance, for module augmentation
    */
-  interface IInstanceAdditionalProperties<
-    ExtraOptions extends UnknownRecord
-  > {}
+  interface IInstanceAdditionalProperties<ExtraOptions extends UnknownRecord> {}
 
   /**
    * App 的类型
@@ -111,10 +109,9 @@ declare namespace MiniProgram.App {
   /**
    * 用户可配置的 App Options
    */
-  type UserAppOptions<
-    ExtraThis,
-    ExtraOptions extends UnknownRecord
-  > = Partial<Options<ExtraOptions>> &
+  type UserAppOptions<ExtraThis, ExtraOptions extends UnknownRecord> = Partial<
+    Options<ExtraOptions>
+  > &
     Partial<
       UniqueLeft<UniqueLeft<ExtraThis, ExtraOptions>, Options<ExtraOptions>>
     > & {
@@ -124,10 +121,7 @@ declare namespace MiniProgram.App {
     } & ThisType<IAppInstance<ExtraThis, ExtraOptions>>;
 
   interface Constructor {
-    <
-      ExtraThis = {},
-      ExtraOptions extends Record<string, unknown> = {}
-    >(
+    <ExtraThis = {}, ExtraOptions extends Record<string, unknown> = {}>(
       opts: UserAppOptions<
         ExtraThis & IGlobalMiniProgramExtraThis4App,
         ExtraOptions
@@ -139,6 +133,9 @@ declare namespace MiniProgram.App {
     <
       ExtraThis = {},
       ExtraOptions extends Record<string, unknown> = {}
-    >(): IAppInstance<ExtraThis & IGlobalMiniProgramExtraThis4App, ExtraOptions>
+    >(): IAppInstance<
+      ExtraThis & IGlobalMiniProgramExtraThis4App,
+      ExtraOptions
+    >;
   }
-}
+}

packages/global/types/lib.component.d.ts

@@ -67,21 +67,6 @@ declare namespace MiniProgram.Component {
     orientation?: 'landscape' | 'portrait';
   }
 
-  interface SetUpdatePerformanceListenerOption<WithDataPath extends boolean> {
-    /**
-     * 是否返回变更的 data 字段信息
-     */
-    withDataPaths?: WithDataPath;
-  }
-
-  interface UpdatePerformanceListener<WithDataPath> {
-    (res: UpdatePerformance<WithDataPath>): void;
-  }
-
-  interface UpdatePerformance<WithDataPath> {
-    // TODO
-  }
-
   interface ILifetimes {
     /**
      * 在组件实例刚刚被创建时执行
@@ -459,12 +444,12 @@ declare namespace MiniProgram.Component {
      */
     hasMixin(mixin: Mixin.IMixinIdentifier): boolean;
     /**
-     * 获取更新性能统计信息
+     * 监听 setData 引发界面更新的开销，参见 获取更新性能统计信息
      * @version 2.8.5
      */
     setUpdatePerformanceListener<WithDataPath extends boolean = false>(
-      option: SetUpdatePerformanceListenerOption<WithDataPath>,
-      callback?: UpdatePerformanceListener<WithDataPath>
+      option: Shared.SetUpdatePerformanceListenerOption<WithDataPath>,
+      callback?: Shared.UpdatePerformanceListener<WithDataPath>
     ): void;
   }
 
@@ -551,11 +536,20 @@ declare namespace MiniProgram.Component {
       Methods = {},
       ExtraThis = {},
       ExtraOptions extends Record<string, unknown> = {},
-      Mixins extends Array<Mixin.IMixin4Legacy | ReturnType<Mixin.Constructor>> = any[]
+      Mixins extends Array<
+        Mixin.IMixin4Legacy | ReturnType<Mixin.Constructor>
+      > = any[]
     >(
       opts: Partial<IOptions<Data, Props, Methods, ExtraOptions, Mixins>> &
         ThisType<
-          IInstance<Data, Props, Methods, ExtraThis & IGlobalMiniProgramExtraThis4Component, ExtraOptions, Mixins>
+          IInstance<
+            Data,
+            Props,
+            Methods,
+            ExtraThis & IGlobalMiniProgramExtraThis4Component,
+            ExtraOptions,
+            Mixins
+          >
         >
     ): void;
   }

packages/global/types/lib.global.d.ts

@@ -1,4 +1,5 @@
-export type IAppOnLaunchOptions<Query extends Record<string, string>> = MiniProgram.App.LaunchOptions<Query>;
+export type IAppOnLaunchOptions<Query extends Record<string, string>> =
+  MiniProgram.App.LaunchOptions<Query>;
 export interface IRequirePlugin<
   Target extends Record<string, any> = Record<string, any>
 > {
@@ -49,7 +50,7 @@ declare global {
    * Page's constructor
    * @link https://opendocs.alipay.com/mini/framework/page-detail
    */
-  const Page: MiniProgram.Page.Constructor
+  const Page: MiniProgram.Page.Constructor;
 
   /**
    * Component's constructor
@@ -62,6 +63,5 @@ declare global {
    * @version 2.8.2
    * @link https://opendocs.alipay.com/mini/05bchn
    */
-  const Mixin: MiniProgram.Mixin.Constructor
+  const Mixin: MiniProgram.Mixin.Constructor;
 }
-

packages/global/types/lib.mixin.d.ts

@@ -2,18 +2,34 @@ declare namespace MiniProgram.Mixin {
   /**
    * 传统的组件间代码复用，仅Component的mixins参数支持传入，Mixin参数mixins 则只支持传入Mixin()的返回值
    */
-  type IMixin4Legacy = Partial<Omit<Component.IOptions<UnknownRecord, UnknownRecord, UnknownRecord, UnknownRecord, []>, 'ref' | 'options' | 'mixins' | 'externalClasses'>>;
+  type IMixin4Legacy = Partial<
+    Omit<
+      Component.IOptions<
+        UnknownRecord,
+        UnknownRecord,
+        UnknownRecord,
+        UnknownRecord,
+        []
+      >,
+      'ref' | 'options' | 'mixins' | 'externalClasses'
+    >
+  >;
   /**
    * Mixin() 返回值
    */
   type IMixinIdentifier = string;
 
-  type IMixinDefinitionFilter = <T extends Component.IOptions<any, any, any, any, any> | IMixinOptions<any, any, any, any, any, any> | Page.IOptions<any, any>>(
+  type IMixinDefinitionFilter = <
+    T extends
+      | Component.IOptions<any, any, any, any, any>
+      | IMixinOptions<any, any, any, any, any, any>
+      | Page.IOptions<any, any>
+  >(
     /** 使用该 mixin 的 component/mixin 的定义对象 */
     defFields: T,
     /** 该 mixin 所使用的 mixin 的 definitionFilter 函数列表 */
     definitionFilterArr?: IMixinDefinitionFilter[] | void
-  ) => void
+  ) => void;
 
   /**
    * Mixin构造器参数
@@ -25,29 +41,39 @@ declare namespace MiniProgram.Mixin {
     ExtraThis,
     ExtraOptions extends UnknownRecord,
     Mixins extends Array<ReturnType<Constructor>>
-    > = {
-    [P in keyof ExtraOptions]: P extends keyof Component.IOptions<
-      Data,
-      Props,
-      Methods,
-      ExtraOptions,
-      Mixins
-    > | 'definitionFilter' | 'mixins'
+  > = {
+    [P in keyof ExtraOptions]: P extends
+      | keyof Component.IOptions<Data, Props, Methods, ExtraOptions, Mixins>
+      | 'definitionFilter'
+      | 'mixins'
       ? unknown
       : ExtraOptions[P];
-    } & Omit<Partial<Component.IOptions<Data, Props, Methods, ExtraOptions, IMixinIdentifier[]>>, 'ref' | 'options' | 'externalClasses'> & Partial<{
-    /**
-    * 定义段过滤器，用于自定义组件扩展
-    */
-      definitionFilter: IMixinDefinitionFilter,
+  } & Omit<
+    Partial<
+      Component.IOptions<Data, Props, Methods, ExtraOptions, IMixinIdentifier[]>
+    >,
+    'ref' | 'options' | 'externalClasses'
+  > &
+    Partial<{
+      /**
+       * 定义段过滤器，用于自定义组件扩展
+       */
+      definitionFilter: IMixinDefinitionFilter;
       /**
-      * 组件间代码复用，用于Mixin()的mixins 只支持传入Mixin()注册生成的返回值。不支持传入 js Object
-      */
-      mixins: Mixins
+       * 组件间代码复用，用于Mixin()的mixins 只支持传入Mixin()注册生成的返回值。不支持传入 js Object
+       */
+      mixins: Mixins;
     }> &
     ThisType<
-      Component.IInstance<Data, Props, Methods, ExtraThis, ExtraOptions, IMixinIdentifier[]>
-  >;
+      Component.IInstance<
+        Data,
+        Props,
+        Methods,
+        ExtraThis,
+        ExtraOptions,
+        IMixinIdentifier[]
+      >
+    >;
 
   interface Constructor {
     <
@@ -57,13 +83,15 @@ declare namespace MiniProgram.Mixin {
       ExtraThis = {},
       ExtraOptions extends Record<string, unknown> = {},
       Mixins extends IMixinIdentifier[] = IMixinIdentifier[]
-    >(options: IMixinOptions<
-      Data,
-      Props,
-      Methods,
-      ExtraThis & IGlobalMiniProgramExtraThis4Component,
-      ExtraOptions,
-      Mixins
-    >): IMixinIdentifier;
+    >(
+      options: IMixinOptions<
+        Data,
+        Props,
+        Methods,
+        ExtraThis & IGlobalMiniProgramExtraThis4Component,
+        ExtraOptions,
+        Mixins
+      >
+    ): IMixinIdentifier;
   }
 }