https://github.com/Ssis53/vite-plugin-zip
Gzip files at build time.
https://github.com/Ssis53/vite-plugin-zip
Last synced: about 2 months ago
JSON representation
Gzip files at build time.
- Host: GitHub
- URL: https://github.com/Ssis53/vite-plugin-zip
- Owner: Ssis53
- License: mit
- Created: 2022-08-18T03:51:28.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-14T03:06:34.000Z (4 months ago)
- Last Synced: 2025-03-12T00:02:12.315Z (about 2 months ago)
- Language: JavaScript
- Size: 279 KB
- Stars: 18
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-vite - vite-plugin-zip-file - Compress files or folders into zip. (Plugins / Framework-agnostic Plugins)
- awesome-vite - vite-plugin-zip-file - Compress files or folders into zip. (Plugins / Framework-agnostic Plugins)
README
# vite-plugin-zip-file
[](./LICENSE)
[](https://www.npmjs.com/package/vite-plugin-zip-file)
Zip files at build time.
**Tips: Node.js 16+ is required.**
# 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 |
| withoutMainFolder | Boolean | false | false | The compressed file whether removes the outermost main folder. |
# Options(中文)
参数
类型
必填
默认值
说明
folderPath
String|Path
是
/dist
需要被压缩的源文件夹
outPath
String|Path
是
/
压缩包输出路径
zipName
String
否
dist
压缩包名称
enabled
Boolean
否
true
用于控制插件是否启用， 通常用于根据环境判断是否压缩文件
deleteFolder
Boolean
否
false
压缩完成后是否删除源文件
withoutMainFolder
Boolean
否
false
压缩后的文件是否去掉最外层文件夹
# Usage
```javascript
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
})
]
})
```