vite-plugin-zip-pack

Vite plugin for packing distribution/build folder into a zip file.

Install

1npm i -D vite-plugin-zip-pack

Usage

1// vite.config.js
2
3import { defineConfig } from "vite";
4import zipPack from "vite-plugin-zip-pack";
5
6export default defineConfig({
7  plugins: [zipPack()],
8});

Options

1export interface Options {
2  /**
3   * Input Directory
4   * @default `dist`
5   */
6  inDir?: string;
7  /**
8   * Output Directory
9   * @default `dist-zip`
10   */
11  outDir?: string;
12  /**
13   * Zip Archive Name
14   * @default `dist.zip`
15   */
16  outFileName?: string;
17  /**
18   * Path prefix for the files included in the zip file
19   * @default ``
20   */
21  pathPrefix?: string;
22  /**
23   * Callback, which is executed after the zip file was created
24   * err is only defined if the save function fails
25   */
26  done?: (err: Error | undefined) => void
27  /**
28   * Filter function equivalent to Array.prototype.filter 
29   * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter
30   * is executed for every files and directories
31   * files and directories are only included when return ist true.
32   * All files are included when function is not defined
33   */
34  filter?: (fileName: string, filePath: string, isDirectory: boolean) => Boolean
35  /**
36   * Enable logging
37   * @default true
38   */
39  enableLogging?: boolean;
40}

License

MIT, see the license file