Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.3 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.3 KB

webpack-archive-plugin

Webpack plugin to create archives of emitted files.

NPM Version NPM Downloads

Installation

npm install --save-dev webpack-archive-plugin

Usage

webpack.config.js:

let ArchivePlugin = require('webpack-archive-plugin');

module.exports = {
	// configuration
	output: {
		path: __dirname + '/dist',
	},
	plugins: [
		new ArchivePlugin(),
	],
}

Will create two archives in the same directory as output.path (__dirname in the example), ${output.path}.tar.gz and ${output.path}.zip containing all compiled assets.

Options

You can pass options when constructing a new plugin, for example ArchivePlugin(options).

The options object supports the following properties:

  • output: string -> Output location / name of archives (without extension)
  • format: string, array -> Archive formats to use, can be 'tar' or 'zip'
  • ext: string -> A different extension to use instead of tar.gz or zip (without leading .)

If options is a string, this is eqiuvalent to passing {output: options}.