Ssis53 / vite-plugin-zip

Gzip files at build time.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

vite-plugin-zip-file

MIT LICENSE size downloads

Zip files at build time.

Install

yarn add vite-plugin-zip-file --dev

or

npm install vite-plugin-zip-file --save-dev

Options

Params Types Rquired Default Desc
folderPath String|Path true /dist Path to the compressed folder
outPath String|Path true / Compressed package output path
zipName String false dist Package name
enabled Boolean false true This parameter is used to control whether the plugin is enabled. It is usually used to determine whether to compress files according to the environment
deleteFolder Boolean false false Whether to delete source files after compression is completed

Options(中文)

参数 类型 必填 默认值 说明
folderPath String|Path /dist 需要被压缩的源文件夹
outPath String|Path / 压缩包输出路径
zipName String dist 压缩包名称
enabled Boolean true 用于控制插件是否启用, 通常用于根据环境判断是否压缩文件
deleteFolder Boolean false 压缩完成后是否删除源文件

Usage

import { defineConfig } from 'vite';
import { viteZip } from 'vite-plugin-zip-file';
import path from 'path';
import { fileURLToPath } from 'url';
import { env } from 'node:process';
const __dirname = path.dirname(fileURLToPath(import.meta.url));

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    viteZip({
      folderPath: path.resolve(__dirname, 'dist'),
      outPath: path.resolve(__dirname),
      zipName: 'Test.zip',
      enabled: env.NODE_ENV === 'production'? true: false
    })
  ]
})

About

Gzip files at build time.

License:MIT License


Languages

Language:JavaScript 55.6%Language:TypeScript 39.0%Language:HTML 5.4%