vite-plugin-performance 1.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": "1.0.0",
+  "version": "2.0.1",
   "description": "vite-plugin-performance",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
@@ -18,16 +18,18 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
+      "import": "./dist/index.mjs"
     }
   },
-  "main": "./dist/index.cjs",
+  "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
   "scripts": {
     "dev": "unbuild --stub",
     "build:watch": "unbuild --watch --sourcemap",

package/dist/index.cjs

@@ -1,127 +0,0 @@
-'use strict';
-
-const DEFAULT_PLUGIN_HOOKS = [
-  "options",
-  "config",
-  "configResolved",
-  "configureServer",
-  "buildStart",
-  "resolveId",
-  "load",
-  "transform",
-  "buildEnd",
-  "generateBundle",
-  "renderChunk",
-  "writeBundle"
-];
-const DEFAULT_THRESHOLD = 0;
-const ANONYMOUS_PLUGIN_NAME = "anonymous-plugin";
-const DEFAULT_FORMATTER = ({ pluginName, hookName, duration }) => {
-  const paddedHook = hookName.padEnd(20);
-  const formattedDuration = duration.toFixed(2).padStart(7);
-  return `[${pluginName}] ${paddedHook} \u23F1 ${formattedDuration} ms`;
-};
-const DEFAULT_LOGGER = (message) => {
-  console.log(message);
-};
-
-const hasPerformanceNow = typeof globalThis !== "undefined" && typeof globalThis.performance?.now === "function";
-const defaultClock = hasPerformanceNow ? () => globalThis.performance.now() : () => Date.now();
-function resolveOptions(options = {}) {
-  const {
-    hooks = DEFAULT_PLUGIN_HOOKS,
-    threshold = DEFAULT_THRESHOLD,
-    silent = options.slient ?? false,
-    logger = DEFAULT_LOGGER,
-    formatter = DEFAULT_FORMATTER,
-    onHookExecution,
-    clock = defaultClock
-  } = options;
-  return {
-    hooks,
-    threshold,
-    silent,
-    logger,
-    formatter,
-    onHookExecution,
-    clock
-  };
-}
-function resolvePluginName(rawName) {
-  return rawName && rawName.length > 0 ? rawName : ANONYMOUS_PLUGIN_NAME;
-}
-
-function ensureArray(value) {
-  return Array.isArray(value) ? value : [value];
-}
-function isPromiseLike(value) {
-  return typeof value === "object" && value !== null && "then" in value;
-}
-
-function wrapPlugin(maybePlugin, options) {
-  const resolvedOptions = resolveOptions(options);
-  const plugins = ensureArray(maybePlugin);
-  const wrapped = plugins.map((plugin) => wrapSinglePlugin(plugin, resolvedOptions));
-  return Array.isArray(maybePlugin) ? wrapped : wrapped[0];
-}
-function wrapSinglePlugin(plugin, options) {
-  const wrapped = { ...plugin };
-  const pluginName = resolvePluginName(plugin.name);
-  const hooksToWrap = resolveHooks(plugin, options.hooks);
-  for (const hookName of hooksToWrap) {
-    const original = plugin[hookName];
-    if (typeof original !== "function") {
-      continue;
-    }
-    wrapped[hookName] = function performanceHook(...args) {
-      const start = options.clock();
-      const invoke = () => original.apply(this, args);
-      const finalize = (result) => {
-        reportExecution({ pluginName, hookName, args, start, options });
-        return result;
-      };
-      const handleError = (error) => {
-        reportExecution({ pluginName, hookName, args, start, options });
-        throw error;
-      };
-      try {
-        const result = invoke();
-        if (isPromiseLike(result)) {
-          return result.then(finalize, handleError);
-        }
-        return finalize(result);
-      } catch (error) {
-        return handleError(error);
-      }
-    };
-  }
-  return wrapped;
-}
-function resolveHooks(plugin, hooks) {
-  if (hooks === "all") {
-    return Object.keys(plugin).filter((key) => typeof plugin[key] === "function");
-  }
-  return [...hooks];
-}
-function reportExecution(params) {
-  const { pluginName, hookName, args, start, options } = params;
-  const duration = Math.max(0, options.clock() - start);
-  const context = {
-    pluginName,
-    hookName,
-    args,
-    duration
-  };
-  if (duration >= options.threshold) {
-    if (!options.silent) {
-      const message = options.formatter(context);
-      options.logger(message, context);
-    }
-    options.onHookExecution?.(context);
-  }
-}
-
-exports.DEFAULT_PLUGIN_HOOKS = DEFAULT_PLUGIN_HOOKS;
-exports.DEFAULT_THRESHOLD = DEFAULT_THRESHOLD;
-exports.resolveOptions = resolveOptions;
-exports.wrapPlugin = wrapPlugin;

package/dist/index.d.cts

@@ -1,50 +0,0 @@
-import { Plugin } from 'vite';
-
-type PluginHookName = Extract<keyof Plugin, string>;
-interface HookExecutionContext {
-    pluginName: string;
-    hookName: PluginHookName;
-    args: unknown[];
-    duration: number;
-}
-type HookLogger = (message: string, context: HookExecutionContext) => void;
-type HookFormatter = (context: HookExecutionContext) => string;
-type HookClock = () => number;
-interface WrapPluginOptions {
-    /** Wrap only these hooks. Use `all` to wrap every function hook on the plugin. */
-    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`. */
-    logger?: HookLogger;
-    /** Custom formatter for the log message. */
-    formatter?: HookFormatter;
-    /** Lifecycle callback invoked after a hook has completed. */
-    onHookExecution?: (context: HookExecutionContext) => void;
-    /** Provide a custom high-resolution clock implementation. */
-    clock?: HookClock;
-    /** @deprecated backwards compatibility typo */
-    slient?: boolean;
-}
-interface ResolvedWrapPluginOptions {
-    hooks: PluginHookName[] | 'all';
-    threshold: number;
-    silent: boolean;
-    logger: HookLogger;
-    formatter: HookFormatter;
-    onHookExecution?: (context: HookExecutionContext) => void;
-    clock: HookClock;
-}
-
-declare const DEFAULT_PLUGIN_HOOKS: PluginHookName[];
-declare const DEFAULT_THRESHOLD = 0;
-
-declare function resolveOptions(options?: Partial<WrapPluginOptions>): ResolvedWrapPluginOptions;
-
-declare function wrapPlugin(maybePlugin: Plugin, options?: Partial<WrapPluginOptions>): Plugin;
-declare function wrapPlugin(maybePlugin: Plugin[], options?: Partial<WrapPluginOptions>): Plugin[];
-
-export { DEFAULT_PLUGIN_HOOKS, DEFAULT_THRESHOLD, resolveOptions, wrapPlugin };
-export type { HookClock, HookExecutionContext, HookFormatter, HookLogger, PluginHookName, ResolvedWrapPluginOptions, WrapPluginOptions };