[](https://codecov.io/gh/nonzzz/vite-compression-plugin)
## Install
```bash
$ yarn add vite-plugin-compression2 -D
# or
$ npm install vite-plugin-compression2 -D
```
## Usage
```js
import { defineConfig } from 'vite'
import { compression } from 'vite-plugin-compression2'
export default defineConfig({
plugins: [
// ...your plugin
compression()
// If you want to create a tarball archive you can import tarball plugin from this package and use
// after compression.
]
})
```
## Options
| params | type | default | description |
| ---------------------- | --------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `include` | `string \| RegExp \| Array` | `/\.(html\|xml\|css\|json\|js\|mjs\|svg\|yaml\|yml\|toml)$/` | Include all assets matching any of these conditions. |
| `exclude` | `string \| RegExp \| Array` | `-` | 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` | `{}` | 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
[FAQ](./Q&A.md)
### Others
- If you want to analysis your bundle assets. Maybe you can try [vite-bundle-analyzer](https://github.com/nonzzz/vite-bundle-analyzer)
- `tarball` option `dest` means to generate a tarball somewhere
- `tarball` is based on the `ustar`. It should be compatible with all popular tar distributions out there (gnutar, bsdtar etc)
### Sponsors
### LICENSE
[MIT](./LICENSE)
## Acknowledgements
[NWYLZW](https://github.com/NWYLZW)
### Author
[Kanno](https://github.com/nonzzz)