vite-plugin-zips

A Vite plugin for automatically compressing specified directories into zip archives after build.

中文文档

📦 Installation

1npm install vite-plugin-zips -D
2# or
3pnpm add vite-plugin-zips -D
4# or
5yarn add vite-plugin-zips -D

🚀 Basic Usage

1import { defineConfig } from "vite";
2import zips from "vite-plugin-zips";
3
4export default defineConfig({
5  plugins: [zips()],
6});

⚙️ Configuration Options

1import { defineConfig } from "vite";
2import zips from "vite-plugin-zips";
3
4export default defineConfig({
5  plugins: [
6    zips({
7      // Directory to zip, default: 'dist'
8      dir: 'dist',
9      // Output filename, default: '{name}.zip' (directory name)
10      out: 'my-build.zip',
11      // Whether to include directory structure, default: true
12      includeDir: true,
13      // Whether to clear old archives, default: true
14      clearOld: true,
15      // Files/patterns to ignore
16      ignore: ['**/*.map', 'temp/**'],
17      // Files/patterns to include, default: ['**/*'] (include all by default)
18      include: ['**/*.js', '**/*.html'],
19      // Path prefix for files in archive, default: '' (no prefix)
20      pathPrefix: 'assets/',
21      // Timezone for date formatting in template variables, default: 'local' (system timezone)
22      timezone: 'Asia/Shanghai'
23    })
24  ],
25});

Configuration Parameters

Parameter	Type	Default	Description
dir	string | string[]	'dist'	Directory(ies) to zip
out	string	'{name}.zip'	Output filename template
includeDir	boolean	true	Whether to include directory structure
clearOld	boolean	true	Whether to clear old archives
ignore	string[]	[]	Files/patterns to ignore (glob patterns)
include	string[]	['**/*']	Files/patterns to include (glob patterns, includes all by default)
pathPrefix	string	''	Path prefix for files in archive
timezone	string	'local'	Timezone for date formatting in template variables

Template Variables

• {name}: Original directory name (or 'dist' for multiple directories)
• {date}: Date in format yyMMdd
• {datetime}: Date and time in format yyMMddHHmmss
• {hash}: Random hash string (8 characters)
• {yyyyMMdd}, {HHmmss}, {yy-MM-dd}, etc.: Custom date format patterns

📚 Usage Examples

Basic Usage

1// Compress 'dist' directory to 'dist.zip'
2zips()

Multiple Directories

1// Compress multiple directories
2zips({
3  dir: ['dist', 'public', 'assets'],
4  out: 'bundle.zip'
5})

Ignore Specific Files

1// Ignore source maps and temporary files
2zips({
3  ignore: ['**/*.map', 'temp/**', '*.log']
4})

Custom Output Filename

1// Use custom filename with various templates
2zips({
3  out: 'my-project-{datetime}.zip'
4})
5
6// Use custom date format
7zips({
8  out: 'build-{yyyy-MM-dd}-{hash}.zip'
9})

Exclude Directory Structure

1// Compress files directly without directory structure
2zips({
3  includeDir: false
4})

Include Specific Files

1// Only include JavaScript and HTML files
2zips({
3  include: ['**/*.js', '**/*.html']
4})

Add Path Prefix

1// Add prefix to all file paths in archive
2zips({
3  pathPrefix: 'dist/'
4})

Timezone Configuration

1// Use UTC timezone
2zips({
3  out: 'build-{datetime}.zip',
4  timezone: 'UTC'
5})
6
7// Use specific timezone (IANA timezone identifier)
8zips({
9  out: 'build-{datetime}.zip',
10  timezone: 'Asia/Shanghai'  // UTC+8
11})
12
13// Use UTC offset format
14zips({
15  out: 'build-{datetime}.zip', 
16  timezone: '+08:00'  // UTC+8
17})
18
19// Use local timezone (default)
20zips({
21  out: 'build-{datetime}.zip',
22  timezone: 'local'
23})

Supported Timezone Formats:

• 'local': Use system local timezone (default)
• 'UTC': Use Coordinated Universal Time
• IANA timezone identifiers: e.g., 'Asia/Shanghai', 'America/New_York', 'Europe/London', etc.
• UTC offset: e.g., '+08:00', '-05:00', etc.

🤝 Contributing

Issues and Pull Requests are welcome!

📄 License

MIT License

🔗 Links

• Repository
• NPM Package