https://github.com/seldszar/archiver-webpack-plugin
Generate a compressed archive of compiled assets.
https://github.com/seldszar/archiver-webpack-plugin
archive compression webpack webpack-plugin
Last synced: 2 months ago
JSON representation
Generate a compressed archive of compiled assets.
- Host: GitHub
- URL: https://github.com/seldszar/archiver-webpack-plugin
- Owner: Seldszar
- License: mit
- Created: 2017-09-26T00:36:30.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-02-28T15:16:32.000Z (over 7 years ago)
- Last Synced: 2025-02-18T04:37:33.649Z (over 1 year ago)
- Topics: archive, compression, webpack, webpack-plugin
- Language: JavaScript
- Homepage:
- Size: 195 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[![npm][npm]][npm-url]
[![node][node]][node-url]
[![dependencies][dependencies]][dependencies-url]
[![test][test]][test-url]
[![semantic-release][semantic-release]][semantic-release-url]
Archiver Plugin
Generate a compressed archive of compiled assets.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API](#api)
- [Author](#author)
- [License](#license)
## Installation
```bash
npm install archiver archiver-webpack-plugin --save-dev
```
## Usage
### Using the built-in Archiver instance
```javascript
const ArchiverPlugin = require("archiver-webpack-plugin");
module.exports = {
plugins: [
new ArchiverPlugin({
format: "zip",
formatOptions: {
zlib: {
level: 9,
},
},
}),
],
};
```
### Using a custom Archiver instance
```javascript
const ArchiverPlugin = require("archiver-webpack-plugin");
const archiver = require("archiver");
const archive = archiver("zip", {
zlib: {
level: 9,
},
});
module.exports = {
plugins: [
new ArchiverPlugin({
archive,
}),
],
};
```
Arguments:
* `output`: The archive output path.
* `test`: All assets matching this RegExp are processed. Defaults to every asset.
* `format`: The archive format. Defaults to `"zip"`.
* `formatOptions`: The archive format options. Defaults to `"{}"`.
* `archive`: An Archiver instance. Defaults to the built-in instance.
## API
See the detailed [API Reference](API.md).
## Author
Alexandre Breteau - [@0xSeldszar](https://twitter.com/0xSeldszar)
## License
MIT © [Alexandre Breteau](https://seldszar.fr)
[npm]: https://img.shields.io/npm/v/archiver-webpack-plugin.svg
[npm-url]: https://npmjs.com/package/archiver-webpack-plugin
[node]: https://img.shields.io/node/v/archiver-webpack-plugin.svg
[node-url]: https://nodejs.org
[dependencies]: https://david-dm.org/Seldszar/archiver-webpack-plugin.svg
[dependencies-url]: https://david-dm.org/Seldszar/archiver-webpack-plugin
[test]: https://secure.travis-ci.org/Seldszar/archiver-webpack-plugin.svg
[test-url]: http://travis-ci.org/Seldszar/archiver-webpack-plugin
[semantic-release]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release-url]: https://github.com/semantic-release/semantic-release