Package Exports
- vite-plugin-zip-zwf
Readme
vite-plugin-zip-zwf
用于vite的压缩插件,打包后自动压缩
安装
npm i -D vite-plugin-zip-zwf注意事项
package.json需要设置如下内容
"type": "module",使用
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import zip from 'vite-plugin-zip-zwf'
export default defineConfig({
plugins: [vue(), zip()],
})
参数
/**
* 插件配置选项接口
* 定义 Vite 打包后压缩插件可配置的所有参数
*/
export interface Options {
/**
* 是否开启插件
* 控制插件是否启用,默认为 true
* 如果设置为 false,则插件不会执行任何操作
* @default true
*/
enable?: boolean;
/**
* 输入目录路径
* 指定需要打包压缩的源文件夹
* @default `dist`
*/
inDir?: string;
/**
* 输出目录路径
* 指定压缩包文件的保存位置
* @default `dist`
*/
outDir?: string;
/**
* 压缩包文件名
* 指定生成的压缩包文件名称
* @default `dist.zip`
*/
outFileName?: string;
/**
* 是否启用日志输出
* 控制插件运行时的日志信息显示
* @default true
*/
enableLogging?: boolean;
/**
* 是否开启版本号
* @default true
*/
enableVersion?: boolean;
/** 是否压缩inDir目录
* 如果设置为 true,则会将 inDir 目录整个压缩,
* 如果设置为 false,只压缩inDir 目录下的所有文件
* @default true
*/
isInclude?: boolean;
}
参数使用案例
假设今天日期为2050-01-01 以下配置将会在zip-folder文件夹下创建名称为2025-01-0的1目录,目录下会有会有
pc_2050-01-01_V1.zip的压缩包,如果不开启enableVersion将不会有版本号;
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import zip from 'vite-plugin-zip-zwf'
export default defineConfig({
plugins: [vue(), zip(
{
inDir:"dist",
outDir:"zip-folder",
outFileName:"pc",
enableLogging:true,
enableVersion:true,
})],
})