npm i -D copy-webpack-plugin
webpack.config.js
const CopyWebpackPlugin = require('copy-webpack-plugin')
const config = {
plugins: [
new CopyWebpackPlugin([ ...patterns ], options)
]
}
ℹ️ If you must have
webpack-dev-server
write files to output directory during development, you can force it with thewrite-file-webpack-plugin
.
A simple pattern looks like this
{ from: 'source', to: 'dest' }
Or, in case of just a from
with the default destination, you can also use a {String}
as shorthand instead of an {Object}
'source'
Name | Type | Default | Description |
---|---|---|---|
from |
{String|Object} |
undefined |
Globs accept minimatch options |
fromArgs |
{Object} |
{ cwd: context } |
See the node-glob options in addition to the ones below |
to |
{String|Object} |
undefined |
Output root if from is file or dir, resolved glob path if from is glob |
toType |
{String} |
`` | toType Options |
force |
{Boolean} |
false |
Overwrites files already in compilation.assets (usually added by other plugins/loaders) |
ignore |
{Array} |
[] |
Globs to ignore for this pattern |
flatten |
{Boolean} |
false |
Removes all directory references and only copies file names. |
transform |
{Function} |
(content, path) => content |
Function that modifies file contents before copying |
cache |
{Boolean|Object} |
false |
Enable transform caching. You can use { cache: { key: 'my-cache-key' } } to invalidate the cache |
context |
{String} |
options.context || compiler.options.context |
A path that determines how to interpret the from path |
webpack.config.js
[
new CopyWebpackPlugin([
'relative/path/to/file.ext'
'/absolute/path/to/file.ext'
'relative/path/to/dir'
'/absolute/path/to/dir'
'**/*'
{ glob: '\*\*/\*', dot: true }
], options)
]
webpack.config.js
[
new CopyWebpackPlugin([
{ from: '**/*', to: 'relative/path/to/dest/' }
{ from: '**/*', to: '/absolute/path/to/dest/' }
], options)
]
Name | Type | Default | Description |
---|---|---|---|
'dir' |
{String} |
undefined |
If from is directory, to has no extension or ends in '/' |
'file' |
{String} |
undefined |
If to has extension or from is file |
'template' |
{String} |
undefined |
If to contains a template pattern |
webpack.config.js
[
new CopyWebpackPlugin([
{
from: 'path/to/file.txt',
to: 'directory/with/extension.ext',
toType: 'dir'
}
], options)
]
webpack.config.js
[
new CopyWebpackPlugin([
{
from: 'path/to/file.txt',
to: 'file/without/extension',
toType: 'file'
},
], options)
]
webpack.config.js
[
new CopyWebpackPlugin([
{
from: 'src/'
to: 'dest/[name].[hash].[ext]',
toType: 'template'
}
], options)
]
webpack.config.js
[
new CopyWebpackPlugin([
{ from: 'src/**/*' to: 'dest/', force: true }
], options)
]
webpack.config.js
[
new CopyWebpackPlugin([
{ from: 'src/**/*' to: 'dest/', ignore: [ '*.js' ] }
], options)
]
webpack.config.js
[
new CopyWebpackPlugin([
{ from: 'src/**/*', to: 'dest/', flatten: true }
], options)
]
webpack.config.js
[
new CopyWebpackPlugin([
{
from: 'src/*.png',
to: 'dest/',
transform (content, path) {
return optimize(content)
}
}
], options)
]
webpack.config.js
[
new CopyWebpackPlugin([
{
from: 'src/*.png',
to: 'dest/',
transform (content, path) {
return optimize(content)
},
cache: true
}
], options)
]
webpack.config.js
[
new CopyWebpackPlugin([
{ from: 'src/*.txt', to: 'dest/', context: 'app/' }
], options)
]
Name | Type | Default | Description |
---|---|---|---|
debug |
{String} |
'warning' |
Debug Options |
ignore |
{Array} |
[] |
Array of globs to ignore (applied to from ) |
context |
{String} |
compiler.options.context |
A path that determines how to interpret the from path, shared for all patterns |
copyUnmodified |
{Boolean} |
false |
Copies files, regardless of modification when using watch or webpack-dev-server . All files are copied on first build, regardless of this option |
Name | Type | Default | Description |
---|---|---|---|
'info' |
{String|Boolean} |
false |
File location and read info |
'debug' |
{String} |
false |
Very detailed debugging info |
'warning' |
{String} |
true |
Only warnings |
webpack.config.js
[
new CopyWebpackPlugin(
[ ...patterns ],
{ debug: 'info' }
)
]
webpack.config.js
[
new CopyWebpackPlugin(
[ ...patterns ],
{ debug: 'debug' }
)
]
webpack.config.js
[
new CopyWebpackPlugin(
[ ...patterns ],
{ debug: true }
)
]
webpack.config.js
[
new CopyWebpackPlugin(
[ ...patterns ],
{ ignore: [ '*.js', '*.css' ] }
)
]
webpack.config.js
[
new CopyWebpackPlugin(
[ ...patterns ],
{ context: [ '/app' ] }
)
]
ℹ️ By default, we only copy modified files during a
webpack --watch
orwebpack-dev-server
build. Setting this option totrue
will copy all files.
webpack.config.js
[
new CopyWebpackPlugin(
[ ...patterns ],
{ copyUnmodified: true }
)
]
![]() Juho Vepsäläinen |
![]() Joshua Wiens |
![]() Michael Ciniawsky |
![]() Alexander Krasnoyarov |