vite-plugin-compression
vite-plugin-compression copied to clipboard
Published
20 hours ago •
nonzzz
nonzzz
vite plugin. compress your bundle file.
Install
$ yarn add vite-plugin-compression2 -D
# or
$ npm install vite-plugin-compression2 -D
Usage
import { defineConfig } from 'vite'
import { compression } from 'vite-plugin-compression2'
export default defineConfig({
plugins: [
// ...your plugin
compression()
]
})
Options
| params | type | default | description |
|---|---|---|---|
include |
string | RegExp | Array<string | RegExp> |
/\.(html|xml|css|json|js|mjs|svg)$/ |
Include all assets matching any of these conditions. |
exclude |
string | RegExp | Array<string | RegExp> |
- |
Exclude all assets matching any of these conditions. |
threshold |
number |
0 |
Only assets bigger than this size are processed (in bytes) |
algorithm |
string| function |
gzip |
The compression algorithm |
compressionOptions |
Record<string,any> |
{} |
Compression options for algorithm(details see zlib module) |
deleteOriginalAssets |
boolean |
false |
Whether to delete the original assets or not |
skipIfLargerOrEqual |
boolean |
true |
Whether to skip the compression if the result is larger than or equal to the original file |
filename |
string |
[path][base].gz |
The target asset filename |
Q & A
Why not vite-plugin-compression
-
vite-plugin-compressionno longer maintenance.
Why vite-plugin-compression2
-
vite-plugin-compression2has minimal dependencies and better performance.
Can i custom the compression algorithm?
- Yes, you can see the unit test case.
Can i generate multiple compressed assets with difference compression algorithm?
import { defineComponent } from 'vite'
import { compression } from 'vite-plugin-compression2'
export default defineComponent({
plugins: [
// ...your plugin
compression(),
compression({ algorithm: 'brotliCompress' })
]
})
Can i create a tarball for all of assets after compressed?
- Yes, you can import
tarballplugin from this package(>=1.0.0)
import { defineComponent } from 'vite'
import { compression, tarball } from 'vite-plugin-compression2'
export default defineComponent({
plugins: [
// ...your plugin
compression(),
tarball()
]
})
Others
-
If you want to analysis your bundle assets. Maybe you can try vite-bundle-analyzer
-
tarballoptiondestmeans to generate a tarball somewhere -
tarballis based on theustart. It should be compatible with all popular tar distributions out there (gnutar, bsdtar etc)
Sponsors
LICENSE
MIT
Author
Kanno
nonzzz