vite-plugin-performance 2.0.0 → 2.0.1

package/dist/index.d.mts

@@ -1,33 +1,51 @@
 import { Plugin } from 'vite';
 
+/**
+ * @description Vite 插件 hook 名称
+ */
 type PluginHookName = Extract<keyof Plugin, string>;
+/**
+ * @description hook 执行上下文
+ */
 interface HookExecutionContext {
     pluginName: string;
     hookName: PluginHookName;
     args: unknown[];
     duration: number;
 }
+/**
+ * @description 日志输出函数
+ */
 type HookLogger = (message: string, context: HookExecutionContext) => void;
+/**
+ * @description 日志格式化函数
+ */
 type HookFormatter = (context: HookExecutionContext) => string;
+/**
+ * @description 自定义计时函数
+ */
 type HookClock = () => number;
 interface WrapPluginOptions {
-    /** Wrap only these hooks. Use `all` to wrap every function hook on the plugin. */
+    /** 仅包裹这些 hooks；传入 `all` 表示包裹插件上的所有函数 hook。 */
     hooks?: PluginHookName[] | 'all';
-    /** Minimum duration (ms) required to log or emit notifications. */
+    /** 触发日志/通知的最小耗时（毫秒）。 */
     threshold?: number;
-    /** Disable the default logger output. */
+    /** 关闭默认日志输出。 */
     silent?: boolean;
-    /** Custom logger called with the formatted message. Defaults to `console.log`. */
+    /** 自定义日志函数，默认使用 `console.log`。 */
     logger?: HookLogger;
-    /** Custom formatter for the log message. */
+    /** 自定义日志格式化函数。 */
     formatter?: HookFormatter;
-    /** Lifecycle callback invoked after a hook has completed. */
+    /** hook 执行完成后的回调。 */
     onHookExecution?: (context: HookExecutionContext) => void;
-    /** Provide a custom high-resolution clock implementation. */
+    /** 自定义高精度计时函数。 */
     clock?: HookClock;
-    /** @deprecated backwards compatibility typo */
+    /** @deprecated 兼容旧拼写 */
     slient?: boolean;
 }
+/**
+ * @description 解析后的插件配置
+ */
 interface ResolvedWrapPluginOptions {
     hooks: PluginHookName[] | 'all';
     threshold: number;
@@ -38,9 +56,18 @@ interface ResolvedWrapPluginOptions {
     clock: HookClock;
 }
 
+/**
+ * @description 默认需要包裹的插件 hooks
+ */
 declare const DEFAULT_PLUGIN_HOOKS: PluginHookName[];
+/**
+ * @description 默认耗时阈值（毫秒）
+ */
 declare const DEFAULT_THRESHOLD = 0;
 
+/**
+ * @description 解析插件配置并补全默认值
+ */
 declare function resolveOptions(options?: Partial<WrapPluginOptions>): ResolvedWrapPluginOptions;
 
 declare function wrapPlugin(maybePlugin: Plugin, options?: Partial<WrapPluginOptions>): Plugin;

package/dist/index.d.ts

@@ -1,33 +1,51 @@
 import { Plugin } from 'vite';
 
+/**
+ * @description Vite 插件 hook 名称
+ */
 type PluginHookName = Extract<keyof Plugin, string>;
+/**
+ * @description hook 执行上下文
+ */
 interface HookExecutionContext {
     pluginName: string;
     hookName: PluginHookName;
     args: unknown[];
     duration: number;
 }
+/**
+ * @description 日志输出函数
+ */
 type HookLogger = (message: string, context: HookExecutionContext) => void;
+/**
+ * @description 日志格式化函数
+ */
 type HookFormatter = (context: HookExecutionContext) => string;
+/**
+ * @description 自定义计时函数
+ */
 type HookClock = () => number;
 interface WrapPluginOptions {
-    /** Wrap only these hooks. Use `all` to wrap every function hook on the plugin. */
+    /** 仅包裹这些 hooks；传入 `all` 表示包裹插件上的所有函数 hook。 */
     hooks?: PluginHookName[] | 'all';
-    /** Minimum duration (ms) required to log or emit notifications. */
+    /** 触发日志/通知的最小耗时（毫秒）。 */
     threshold?: number;
-    /** Disable the default logger output. */
+    /** 关闭默认日志输出。 */
     silent?: boolean;
-    /** Custom logger called with the formatted message. Defaults to `console.log`. */
+    /** 自定义日志函数，默认使用 `console.log`。 */
     logger?: HookLogger;
-    /** Custom formatter for the log message. */
+    /** 自定义日志格式化函数。 */
     formatter?: HookFormatter;
-    /** Lifecycle callback invoked after a hook has completed. */
+    /** hook 执行完成后的回调。 */
     onHookExecution?: (context: HookExecutionContext) => void;
-    /** Provide a custom high-resolution clock implementation. */
+    /** 自定义高精度计时函数。 */
     clock?: HookClock;
-    /** @deprecated backwards compatibility typo */
+    /** @deprecated 兼容旧拼写 */
     slient?: boolean;
 }
+/**
+ * @description 解析后的插件配置
+ */
 interface ResolvedWrapPluginOptions {
     hooks: PluginHookName[] | 'all';
     threshold: number;
@@ -38,9 +56,18 @@ interface ResolvedWrapPluginOptions {
     clock: HookClock;
 }
 
+/**
+ * @description 默认需要包裹的插件 hooks
+ */
 declare const DEFAULT_PLUGIN_HOOKS: PluginHookName[];
+/**
+ * @description 默认耗时阈值（毫秒）
+ */
 declare const DEFAULT_THRESHOLD = 0;
 
+/**
+ * @description 解析插件配置并补全默认值
+ */
 declare function resolveOptions(options?: Partial<WrapPluginOptions>): ResolvedWrapPluginOptions;
 
 declare function wrapPlugin(maybePlugin: Plugin, options?: Partial<WrapPluginOptions>): Plugin;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vite-plugin-performance",
   "type": "module",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "vite-plugin-performance",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",