3.1.2 • Published 8 months ago
vite-plugin-zip-file v3.1.2
vite-plugin-zip-file
Zip files at build time.
Tips: Node.js 16+ is required.
Install
yarn add vite-plugin-zip-file --devor
npm install vite-plugin-zip-file --save-devOptions
| 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 |
| withoutMainFolder | Boolean | false | false | The compressed file whether removes the outermost main folder. |
Options(中文)
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
})
]
})