npm - @meng-xi/vite-plugin - Versions diffs - 0.0.2 → 0.0.3 - Mend

@meng-xi/vite-plugin 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (45) hide show

package/README-en.md +150 -150
package/README.md +84 -84
package/dist/common/index.cjs +1 -0
package/dist/common/index.d.cts +109 -0
package/dist/common/index.d.mts +109 -0
package/dist/common/index.d.ts +109 -0
package/dist/common/index.mjs +1 -0
package/dist/factory/index.cjs +1 -0
package/dist/factory/index.d.cts +260 -0
package/dist/factory/index.d.mts +260 -0
package/dist/factory/index.d.ts +260 -0
package/dist/factory/index.mjs +1 -0
package/dist/index.cjs +1 -5
package/dist/index.d.cts +7 -241
package/dist/index.d.mts +7 -241
package/dist/index.d.ts +7 -241
package/dist/index.mjs +1 -5
package/dist/logger/index.cjs +1 -0
package/dist/logger/index.d.cts +1 -0
package/dist/logger/index.d.mts +1 -0
package/dist/logger/index.d.ts +1 -0
package/dist/logger/index.mjs +1 -0
package/dist/plugins/index.cjs +1 -0
package/dist/plugins/index.d.cts +210 -0
package/dist/plugins/index.d.mts +210 -0
package/dist/plugins/index.d.ts +210 -0
package/dist/plugins/index.mjs +1 -0
package/dist/shared/vite-plugin.B3PARlU9.d.cts +119 -0
package/dist/shared/vite-plugin.B3PARlU9.d.mts +119 -0
package/dist/shared/vite-plugin.B3PARlU9.d.ts +119 -0
package/dist/shared/vite-plugin.BT1oHRKK.cjs +1 -0
package/dist/shared/vite-plugin.BTKhc7n7.cjs +3 -0
package/dist/shared/vite-plugin.BZqhBDYR.mjs +1 -0
package/dist/shared/vite-plugin.Bn8mcCzy.cjs +3 -0
package/dist/shared/vite-plugin.CY2ydccp.mjs +3 -0
package/dist/shared/vite-plugin.CiHfwMiN.d.cts +91 -0
package/dist/shared/vite-plugin.CiHfwMiN.d.mts +91 -0
package/dist/shared/vite-plugin.CiHfwMiN.d.ts +91 -0
package/dist/shared/vite-plugin.ClHiVXD6.mjs +1 -0
package/dist/shared/vite-plugin.DSRKYuae.mjs +3 -0
package/dist/shared/vite-plugin.DrSzERYS.cjs +1 -0
package/dist/shared/vite-plugin.UkE7CdSe.d.cts +43 -0
package/dist/shared/vite-plugin.UkE7CdSe.d.mts +43 -0
package/dist/shared/vite-plugin.UkE7CdSe.d.ts +43 -0
package/package.json +72 -53

package/dist/plugins/index.d.mts ADDED Viewed

@@ -0,0 +1,210 @@
+import { B as BasePluginOptions, P as PluginFactory } from '../shared/vite-plugin.UkE7CdSe.mjs';
+import 'vite';
+/**
+ * 复制文件插件的配置选项接口
+ *
+ * @interface CopyFileOptions
+ */
+interface CopyFileOptions extends BasePluginOptions {
+    /**
+     * 源文件目录的路径
+     *
+     * @example 'src/assets'
+     */
+    sourceDir: string;
+    /**
+     * 目标文件目录的路径
+     *
+     * @example 'dist/assets'
+     */
+    targetDir: string;
+    /**
+     * 是否覆盖同名文件
+     *
+     * @default true
+     */
+    overwrite?: boolean;
+    /**
+     * 是否支持递归复制
+     *
+     * @default true
+     */
+    recursive?: boolean;
+    /**
+     * 是否启用增量复制
+     *
+     * @default true
+     */
+    incremental?: boolean;
+}
+/**
+ * 复制文件插件
+ *
+ * @param {CopyFileOptions} options - 插件配置选项
+ * @returns {Plugin} 一个 Vite 插件实例
+ *
+ * @example
+ * ```typescript
+ * // 基本使用
+ * copyFile({
+ *   sourceDir: 'src/assets',
+ *   targetDir: 'dist/assets'
+ * })
+ *
+ * // 高级配置
+ * copyFile({
+ *   sourceDir: 'src/static',
+ *   targetDir: 'dist/static',
+ *   overwrite: false,
+ *   recursive: true,
+ *   incremental: true,
+ *   enabled: true,
+ *   verbose: true,
+ *   errorStrategy: 'throw'
+ * })
+ * ```
+ *
+ * @remarks
+ * 该插件会在 Vite 构建完成后执行，将指定源目录的所有文件和子目录复制到目标目录。
+ * 支持增量复制、递归复制和覆盖控制等功能。
+ */
+declare const copyFile: PluginFactory<CopyFileOptions, CopyFileOptions>;
+/**
+ * 图标配置项接口
+ *
+ * @interface Icon
+ */
+interface Icon {
+    /**
+     * 图标关系类型
+     */
+    rel: string;
+    /**
+     * 图标 URL
+     */
+    href: string;
+    /**
+     * 图标尺寸
+     */
+    sizes?: string;
+    /**
+     * 图标 MIME 类型
+     */
+    type?: string;
+}
+/**
+ * 图标文件复制配置选项接口
+ *
+ * @interface CopyOptions
+ */
+interface CopyOptions {
+    /**
+     * 图标源文件目录，用于复制图标到打包目录
+     *
+     * @example 'src/assets/icons'
+     */
+    sourceDir: string;
+    /**
+     * 图标目标目录（打包目录），用于复制图标到打包目录
+     *
+     * @example 'dist/assets/icons'
+     */
+    targetDir: string;
+    /**
+     * 是否覆盖同名文件
+     *
+     * @default true
+     */
+    overwrite?: boolean;
+    /**
+     * 是否支持递归复制
+     *
+     * @default true
+     */
+    recursive?: boolean;
+}
+/**
+ * 注入网站图标链接的配置选项接口
+ *
+ * @interface InjectIcoOptions
+ */
+interface InjectIcoOptions extends BasePluginOptions {
+    /**
+     * 图标文件的基础路径，默认为根路径 '/'
+     *
+     * @default '/'
+     * @example '/assets'
+     */
+    base?: string;
+    /**
+     * 图标的完整 URL，如果提供则优先使用（覆盖 base + favicon.ico）
+     *
+     * @example 'https://example.com/favicon.ico'
+     */
+    url?: string;
+    /**
+     * 自定义的完整 link 标签 HTML，如果提供则优先使用（覆盖 url 和 base）
+     *
+     * @example '<link rel="icon" href="/favicon.svg" type="image/svg+xml" />'
+     */
+    link?: string;
+    /**
+     * 自定义图标数组，支持多种图标格式和尺寸
+     *
+     * @example
+     * [
+     *   { rel: 'icon', href: '/favicon.svg', type: 'image/svg+xml' },
+     *   { rel: 'icon', href: '/favicon-32x32.png', sizes: '32x32', type: 'image/png' },
+     *   { rel: 'icon', href: '/favicon-16x16.png', sizes: '16x16', type: 'image/png' }
+     * ]
+     */
+    icons?: Icon[];
+    /**
+     * 图标文件复制配置选项
+     *
+     * @remarks
+     * 当此对象存在时，才会开启图标文件复制功能
+     */
+    copyOptions?: CopyOptions;
+}
+/**
+ * 创建注入图标插件实例
+ *
+ * @export
+ * @param {string | InjectIcoOptions} [options] - 插件配置选项，可以是字符串形式的 base 路径或完整的配置对象
+ * @returns {Plugin} Vite 插件实例，用于在构建过程中注入图标链接到 HTML 文件
+ * @example
+ * ```typescript
+ * // 基本使用
+ * injectIco() // 使用默认配置
+ *
+ * // 使用字符串配置 base 路径
+ * injectIco('/assets')
+ *
+ * // 使用完整配置
+ * injectIco({
+ *   base: '/assets',
+ *   icons: [
+ *     { rel: 'icon', href: '/favicon.svg', type: 'image/svg+xml' },
+ *     { rel: 'icon', href: '/favicon-32x32.png', sizes: '32x32', type: 'image/png' }
+ *   ],
+ *   copyOptions: {
+ *     sourceDir: 'src/assets/icons',
+ *     targetDir: 'dist/assets/icons'
+ *   }
+ * })
+ * ```
+ * @remarks
+ * 该函数创建并返回一个 Vite 插件实例，该实例会在构建过程中：
+ * 1. 将图标链接注入到 HTML 文件的 `<head>` 标签中
+ * 2. 如果配置了 copyOptions，将图标文件复制到目标目录
+ *
+ * 支持自定义图标链接、图标数组配置以及图标文件复制功能。
+ */
+declare const injectIco: PluginFactory<InjectIcoOptions, string | InjectIcoOptions>;
+export { copyFile, injectIco };

package/dist/plugins/index.d.ts ADDED Viewed

@@ -0,0 +1,210 @@
+import { B as BasePluginOptions, P as PluginFactory } from '../shared/vite-plugin.UkE7CdSe.js';
+import 'vite';
+/**
+ * 复制文件插件的配置选项接口
+ *
+ * @interface CopyFileOptions
+ */
+interface CopyFileOptions extends BasePluginOptions {
+    /**
+     * 源文件目录的路径
+     *
+     * @example 'src/assets'
+     */
+    sourceDir: string;
+    /**
+     * 目标文件目录的路径
+     *
+     * @example 'dist/assets'
+     */
+    targetDir: string;
+    /**
+     * 是否覆盖同名文件
+     *
+     * @default true
+     */
+    overwrite?: boolean;
+    /**
+     * 是否支持递归复制
+     *
+     * @default true
+     */
+    recursive?: boolean;
+    /**
+     * 是否启用增量复制
+     *
+     * @default true
+     */
+    incremental?: boolean;
+}
+/**
+ * 复制文件插件
+ *
+ * @param {CopyFileOptions} options - 插件配置选项
+ * @returns {Plugin} 一个 Vite 插件实例
+ *
+ * @example
+ * ```typescript
+ * // 基本使用
+ * copyFile({
+ *   sourceDir: 'src/assets',
+ *   targetDir: 'dist/assets'
+ * })
+ *
+ * // 高级配置
+ * copyFile({
+ *   sourceDir: 'src/static',
+ *   targetDir: 'dist/static',
+ *   overwrite: false,
+ *   recursive: true,
+ *   incremental: true,
+ *   enabled: true,
+ *   verbose: true,
+ *   errorStrategy: 'throw'
+ * })
+ * ```
+ *
+ * @remarks
+ * 该插件会在 Vite 构建完成后执行，将指定源目录的所有文件和子目录复制到目标目录。
+ * 支持增量复制、递归复制和覆盖控制等功能。
+ */
+declare const copyFile: PluginFactory<CopyFileOptions, CopyFileOptions>;
+/**
+ * 图标配置项接口
+ *
+ * @interface Icon
+ */
+interface Icon {
+    /**
+     * 图标关系类型
+     */
+    rel: string;
+    /**
+     * 图标 URL
+     */
+    href: string;
+    /**
+     * 图标尺寸
+     */
+    sizes?: string;
+    /**
+     * 图标 MIME 类型
+     */
+    type?: string;
+}
+/**
+ * 图标文件复制配置选项接口
+ *
+ * @interface CopyOptions
+ */
+interface CopyOptions {
+    /**
+     * 图标源文件目录，用于复制图标到打包目录
+     *
+     * @example 'src/assets/icons'
+     */
+    sourceDir: string;
+    /**
+     * 图标目标目录（打包目录），用于复制图标到打包目录
+     *
+     * @example 'dist/assets/icons'
+     */
+    targetDir: string;
+    /**
+     * 是否覆盖同名文件
+     *
+     * @default true
+     */
+    overwrite?: boolean;
+    /**
+     * 是否支持递归复制
+     *
+     * @default true
+     */
+    recursive?: boolean;
+}
+/**
+ * 注入网站图标链接的配置选项接口
+ *
+ * @interface InjectIcoOptions
+ */
+interface InjectIcoOptions extends BasePluginOptions {
+    /**
+     * 图标文件的基础路径，默认为根路径 '/'
+     *
+     * @default '/'
+     * @example '/assets'
+     */
+    base?: string;
+    /**
+     * 图标的完整 URL，如果提供则优先使用（覆盖 base + favicon.ico）
+     *
+     * @example 'https://example.com/favicon.ico'
+     */
+    url?: string;
+    /**
+     * 自定义的完整 link 标签 HTML，如果提供则优先使用（覆盖 url 和 base）
+     *
+     * @example '<link rel="icon" href="/favicon.svg" type="image/svg+xml" />'
+     */
+    link?: string;
+    /**
+     * 自定义图标数组，支持多种图标格式和尺寸
+     *
+     * @example
+     * [
+     *   { rel: 'icon', href: '/favicon.svg', type: 'image/svg+xml' },
+     *   { rel: 'icon', href: '/favicon-32x32.png', sizes: '32x32', type: 'image/png' },
+     *   { rel: 'icon', href: '/favicon-16x16.png', sizes: '16x16', type: 'image/png' }
+     * ]
+     */
+    icons?: Icon[];
+    /**
+     * 图标文件复制配置选项
+     *
+     * @remarks
+     * 当此对象存在时，才会开启图标文件复制功能
+     */
+    copyOptions?: CopyOptions;
+}
+/**
+ * 创建注入图标插件实例
+ *
+ * @export
+ * @param {string | InjectIcoOptions} [options] - 插件配置选项，可以是字符串形式的 base 路径或完整的配置对象
+ * @returns {Plugin} Vite 插件实例，用于在构建过程中注入图标链接到 HTML 文件
+ * @example
+ * ```typescript
+ * // 基本使用
+ * injectIco() // 使用默认配置
+ *
+ * // 使用字符串配置 base 路径
+ * injectIco('/assets')
+ *
+ * // 使用完整配置
+ * injectIco({
+ *   base: '/assets',
+ *   icons: [
+ *     { rel: 'icon', href: '/favicon.svg', type: 'image/svg+xml' },
+ *     { rel: 'icon', href: '/favicon-32x32.png', sizes: '32x32', type: 'image/png' }
+ *   ],
+ *   copyOptions: {
+ *     sourceDir: 'src/assets/icons',
+ *     targetDir: 'dist/assets/icons'
+ *   }
+ * })
+ * ```
+ * @remarks
+ * 该函数创建并返回一个 Vite 插件实例，该实例会在构建过程中：
+ * 1. 将图标链接注入到 HTML 文件的 `<head>` 标签中
+ * 2. 如果配置了 copyOptions，将图标文件复制到目标目录
+ *
+ * 支持自定义图标链接、图标数组配置以及图标文件复制功能。
+ */
+declare const injectIco: PluginFactory<InjectIcoOptions, string | InjectIcoOptions>;
+export { copyFile, injectIco };

package/dist/plugins/index.mjs ADDED Viewed

	@@ -0,0 +1 @@
1	+ export{c as copyFile,i as injectIco}from"../shared/vite-plugin.CY2ydccp.mjs";import"../shared/vite-plugin.ClHiVXD6.mjs";import"../logger/index.mjs";import"fs";import"path";import"../shared/vite-plugin.DSRKYuae.mjs";import"../shared/vite-plugin.BZqhBDYR.mjs";

package/dist/shared/vite-plugin.B3PARlU9.d.cts ADDED Viewed

@@ -0,0 +1,119 @@
+/**
+ * 构造函数参数接口
+ */
+interface LoggerOptions {
+    /**
+     * 插件名称
+     */
+    name: string;
+    /**
+     * 是否启用日志
+     */
+    enabled?: boolean;
+}
+/**
+ * 日志工具类（单例模式）
+ * @description 全局单例日志管理器，统一管理所有插件的日志输出
+ */
+declare class Logger {
+    /**
+     * 单例实例
+     */
+    private static instance;
+    /**
+     * 库名称
+     */
+    private readonly libName;
+    /**
+     * 插件日志配置映射表
+     * @description 存储每个插件的日志开关状态
+     */
+    private pluginConfigs;
+    /**
+     * 日志类型映射
+     */
+    private readonly logTypes;
+    /**
+     * 私有构造函数，防止外部实例化
+     */
+    private constructor();
+    /**
+     * 获取单例实例
+     * @returns Logger 单例实例
+     */
+    private static getInstance;
+    /**
+     * 创建日志记录器（工厂方法）
+     * @param options 配置选项
+     * @returns Logger 单例实例
+     * @description 为插件创建日志记录器，实际返回单例实例并注册插件配置
+     */
+    static create(options: LoggerOptions): Logger;
+    /**
+     * 注册插件日志配置
+     * @param pluginName 插件名称
+     * @param enabled 是否启用日志
+     */
+    private registerPlugin;
+    /**
+     * 生成日志前缀
+     * @param pluginName 插件名称
+     * @returns 格式化的日志前缀
+     */
+    private formatPrefix;
+    /**
+     * 检查插件日志是否启用
+     * @param pluginName 插件名称
+     * @returns 是否启用
+     */
+    private isPluginEnabled;
+    /**
+     * 统一日志输出方法
+     * @param pluginName 插件名称
+     * @param type 日志类型
+     * @param message 日志消息
+     * @param data 附加数据
+     */
+    private log;
+    /**
+     * 创建插件日志代理对象
+     * @param pluginName 插件名称
+     * @returns 插件日志代理对象
+     * @internal 供 BasePlugin 内部使用
+     */
+    createPluginLogger(pluginName: string): PluginLogger;
+}
+/**
+ * 插件日志代理接口
+ * @description 为每个插件提供独立的日志接口
+ */
+interface PluginLogger {
+    /**
+     * 输出成功日志
+     * @param message 日志消息
+     * @param data 附加数据
+     */
+    success(message: string, data?: any): void;
+    /**
+     * 输出信息日志
+     * @param message 日志消息
+     * @param data 附加数据
+     */
+    info(message: string, data?: any): void;
+    /**
+     * 输出警告日志
+     * @param message 日志消息
+     * @param data 附加数据
+     */
+    warn(message: string, data?: any): void;
+    /**
+     * 输出错误日志
+     * @param message 日志消息
+     * @param data 附加数据
+     */
+    error(message: string, data?: any): void;
+}
+export { Logger as L };
+export type { PluginLogger as P, LoggerOptions as a };

package/dist/shared/vite-plugin.B3PARlU9.d.mts ADDED Viewed

@@ -0,0 +1,119 @@
+/**
+ * 构造函数参数接口
+ */
+interface LoggerOptions {
+    /**
+     * 插件名称
+     */
+    name: string;
+    /**
+     * 是否启用日志
+     */
+    enabled?: boolean;
+}
+/**
+ * 日志工具类（单例模式）
+ * @description 全局单例日志管理器，统一管理所有插件的日志输出
+ */
+declare class Logger {
+    /**
+     * 单例实例
+     */
+    private static instance;
+    /**
+     * 库名称
+     */
+    private readonly libName;
+    /**
+     * 插件日志配置映射表
+     * @description 存储每个插件的日志开关状态
+     */
+    private pluginConfigs;
+    /**
+     * 日志类型映射
+     */
+    private readonly logTypes;
+    /**
+     * 私有构造函数，防止外部实例化
+     */
+    private constructor();
+    /**
+     * 获取单例实例
+     * @returns Logger 单例实例
+     */
+    private static getInstance;
+    /**
+     * 创建日志记录器（工厂方法）
+     * @param options 配置选项
+     * @returns Logger 单例实例
+     * @description 为插件创建日志记录器，实际返回单例实例并注册插件配置
+     */
+    static create(options: LoggerOptions): Logger;
+    /**
+     * 注册插件日志配置
+     * @param pluginName 插件名称
+     * @param enabled 是否启用日志
+     */
+    private registerPlugin;
+    /**
+     * 生成日志前缀
+     * @param pluginName 插件名称
+     * @returns 格式化的日志前缀
+     */
+    private formatPrefix;
+    /**
+     * 检查插件日志是否启用
+     * @param pluginName 插件名称
+     * @returns 是否启用
+     */
+    private isPluginEnabled;
+    /**
+     * 统一日志输出方法
+     * @param pluginName 插件名称
+     * @param type 日志类型
+     * @param message 日志消息
+     * @param data 附加数据
+     */
+    private log;
+    /**
+     * 创建插件日志代理对象
+     * @param pluginName 插件名称
+     * @returns 插件日志代理对象
+     * @internal 供 BasePlugin 内部使用
+     */
+    createPluginLogger(pluginName: string): PluginLogger;
+}
+/**
+ * 插件日志代理接口
+ * @description 为每个插件提供独立的日志接口
+ */
+interface PluginLogger {
+    /**
+     * 输出成功日志
+     * @param message 日志消息
+     * @param data 附加数据
+     */
+    success(message: string, data?: any): void;
+    /**
+     * 输出信息日志
+     * @param message 日志消息
+     * @param data 附加数据
+     */
+    info(message: string, data?: any): void;
+    /**
+     * 输出警告日志
+     * @param message 日志消息
+     * @param data 附加数据
+     */
+    warn(message: string, data?: any): void;
+    /**
+     * 输出错误日志
+     * @param message 日志消息
+     * @param data 附加数据
+     */
+    error(message: string, data?: any): void;
+}
+export { Logger as L };
+export type { PluginLogger as P, LoggerOptions as a };