heybrostudio/vite-plugin-fflate-zip

Vite plugin for packaging build folder into zip file via fflate

Vite plugin for packaging build folder into zip file via fflate.

Install

bun add vite-plugin-fflate-zip -D

pnpm add vite-plugin-fflate-zip -D

npm install vite-plugin-fflate-zip -D

yarn add vite-plugin-fflate-zip -D

Usage

// vite.config.ts
import { defineConfig } from "vite"
import fflateZip from "vite-plugin-fflate-zip"

export default defineConfig({
  plugins: [fflateZip()]
})

Plugin Options

interface Options {
  /**
   * Input Directory
   * @default `dist`
   */
  inDir: string;
  /**
   * Output Directory
   * @default `dist-zip`
   */
  outDir: string;
  /**
   * Zip Archive Name. 
   * @default `${pkg.name}-${pkg.version}.zip`
   */
  zipName: string;
  /**
   * Files to be excluded
   */
  excludedFiles: string[];
  /**
   * After creating the zip file execute
   */
  onArchived: () => void;
  /**
   * Execute when an error occurs
   * @param err Error message
   */
  onError: (err: Error) => void;
}

Develop

To install dependencies:

bun install

To run dev:

bun run dev

To testing at example:

bun run build:example

To build plugin:

bun run build

Authors

• @Caven

License

MIT License © 2024-PRESENT Caven