Vite 中文文档

vite-plugin-compression


English| 中文

Use gzip or brotli to compress resources.

Since vite-plugin-compress does not support gzip compression, a separate copy has been modified and some functions have been added.

Install (yarn or npm)


node version:>=12.0.0

vite version:>=2.0.0

  1. ``` sh
  2. yarn add vite-plugin-compression -D

  4. ```

or

  1. ``` sh
  2. npm i vite-plugin-compression -D

  4. ```

Usage


Configuration plugin in vite.config.ts

  1. ``` ts
  2. import viteCompression from 'vite-plugin-compression';

  4. export default () => {
  5.   return {
  6.     plugins: [viteCompression()],
  7.   };
  8. };
  9. ```

Options


params type default default
:--- :--- :--- :---
verbose boolean true Whether to output the compressed result in the console
filter RegExp or (file: string) => boolean DefaultFilter Specify which resources are not compressed
disable boolean false Whether to disable
threshold number 1025 It will be compressed if the volume is larger than threshold, the unit is b
algorithm string gzip Compression algorithm, optional ['gzip','brotliCompress' ,'deflate','deflateRaw']
ext string .gz Suffix of the generated compressed package
compressionOptions object - The parameters of the corresponding compression algorithm
deleteOriginFile boolean - Whether to delete source files after compression

DefaultFilter

/\.(js|mjs|json|css|html)$/i

Example


Run Example

  1. ``` shell
  2. cd ./example

  4. yarn install

  6. yarn test:gzip

  8. yarn test:br

  10. ```

Sample project


Vben Admin

License


MIT

Inspiration


vite-plugin-compress