copy-webpack-plugin
Advanced tools
The copy-webpack-plugin is a webpack plugin that allows you to copy files and directories from one location to another within your build process. It is commonly used to copy static assets such as images, fonts, and HTML files to the output directory defined in your webpack configuration.
Copying individual files or entire directories
This feature allows you to copy individual files or entire directories from a specified source to a destination within your output directory. The 'from' field specifies the relative or absolute path to the source file or directory, and the 'to' field specifies the relative path to the destination within the output directory.
new CopyPlugin({ patterns: [{ from: 'source', to: 'dest' }] })Ignoring files
This feature allows you to exclude specific files or patterns from being copied. In the provided code sample, all JavaScript files are ignored and will not be copied to the destination.
new CopyPlugin({ patterns: [{ from: 'source', to: 'dest', globOptions: { ignore: ['**/*.js'] } }] })Adding context to file paths
This feature allows you to specify a context for the file paths. The 'context' option sets a base path for the 'from' property. In the code sample, the actual path that will be copied is 'app/source'.
new CopyPlugin({ patterns: [{ from: 'source', to: 'dest', context: 'app' }] })Transforming file content
This feature allows you to modify the content of files before they are copied. The 'transform' function receives the content of the file and its path, and it should return the new content. This can be used to minify files, add banners, or perform other transformations.
new CopyPlugin({ patterns: [{ from: 'source', to: 'dest', transform: (content, path) => { return modifyContent(content); } }] })The file-loader resolves import/require() on a file into a url and emits the file into the output directory. It is similar to copy-webpack-plugin in that it helps manage static assets, but it is more focused on handling assets within the module system.
The html-webpack-plugin simplifies the creation of HTML files to serve your webpack bundles. It can copy HTML files and automatically inject script tags for bundle files. It differs from copy-webpack-plugin by focusing on HTML files and their dependencies.
The assets-webpack-plugin generates a JSON file with the assets produced by webpack. It is similar to copy-webpack-plugin in that it deals with the output of assets, but it does not copy files; instead, it provides a manifest of the generated assets.
Copies individual files or entire directories to the build directory.
To begin, you'll need to install copy-webpack-plugin:
$ npm install copy-webpack-plugin --save-dev
Then add the loader to your webpack config. For example:
webpack.config.js
const CopyPlugin = require('copy-webpack-plugin');
module.exports = {
plugins: [
new CopyPlugin([
{ from: 'source', to: 'dest' },
{ from: 'other', to: 'public' },
]),
],
};
ℹ️ If you want
webpack-dev-serverto write files to the output directory during development, you can force it with thewriteToDiskoption or thewrite-file-webpack-plugin.
The plugin's signature:
webpack.config.js
module.exports = {
plugins: [new CopyPlugin(patterns, options)],
};
| Name | Type | Default | Description |
|---|---|---|---|
from | {String|Object} | undefined | Globs accept minimatch options. 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} | undefined | [toType Options](#totype). |
test | {RegExp} | undefined | Pattern for extracting elements to be used in to templates. |
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.⚠️ If files have the same name, the result is non-deterministic. |
transform | {Function|Promise} | (content, path) => content | Function or Promise that modifies file contents before copying. |
transformPath | {Function|Promise} | (targetPath, sourcePath) => path | Function or Promise that modifies file writing path. |
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. |
fromwebpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
'relative/path/to/file.ext',
'/absolute/path/to/file.ext',
'relative/path/to/dir',
'/absolute/path/to/dir',
'**/*',
{ glob: '**/*', dot: false },
]),
],
};
towebpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{ from: '**/*', to: 'relative/path/to/dest/' },
{ from: '**/*', to: '/absolute/path/to/dest/' },
]),
],
};
toType| 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 |
'dir'webpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: 'path/to/file.txt',
to: 'directory/with/extension.ext',
toType: 'dir',
},
]),
],
};
'file'webpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: 'path/to/file.txt',
to: 'file/without/extension',
toType: 'file',
},
]),
],
};
'template'webpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: 'src/',
to: 'dest/[name].[hash].[ext]',
toType: 'template',
},
]),
],
};
testDefines a {RegExp} to match some parts of the file path.
These capture groups can be reused in the name property using [N] placeholder.
Note that [0] will be replaced by the entire path of the file,
whereas [1] will contain the first capturing parenthesis of your {RegExp}
and so on...
webpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: '*/*',
to: '[1]-[2].[hash].[ext]',
test: /([^/]+)\/(.+)\.png$/,
},
]),
],
};
forcewebpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: 'src/**/*',
to: 'dest/',
force: true,
},
]),
],
};
ignorewebpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: 'src/**/*',
to: 'dest/',
ignore: ['*.js'],
},
]),
],
};
flattenwebpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: 'src/**/*',
to: 'dest/',
flatten: true,
},
]),
],
};
transform{Function}webpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: 'src/*.png',
to: 'dest/',
transform(content, path) {
return optimize(content);
},
},
]),
],
};
{Promise}webpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: 'src/*.png',
to: 'dest/',
transform(content, path) {
return Promise.resolve(optimize(content));
},
},
]),
],
};
transformPath{Function}webpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: 'src/*.png',
to: 'dest/',
transformPath(targetPath, absolutePath) {
return 'newPath';
},
},
]),
],
};
{Promise}webpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: 'src/*.png',
to: 'dest/',
transformPath(targePath, absolutePath) {
return Promise.resolve('newPath');
},
},
]),
],
};
cachewebpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: 'src/*.png',
to: 'dest/',
transform(content, path) {
return optimize(content);
},
cache: true,
},
]),
],
};
contextwebpack.config.js
module.exports = {
plugins: [
new CopyPlugin([
{
from: 'src/*.txt',
to: 'dest/',
context: 'app/',
},
]),
],
};
| Name | Type | Default | Description |
|---|---|---|---|
logLevel | {String} | 'warn' | Level of messages that the module will log |
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 |
logLevelThis property defines the level of messages that the module will log. Valid levels include:
tracedebuginfowarn (default)errorsilentSetting a log level means that all other levels below it will be visible in the
console. Setting logLevel: 'silent' will hide all console output. The module
leverages webpack-log
for logging management, and more information can be found on its page.
webpack.config.js
module.exports = {
plugins: [new CopyPlugin([...patterns], { logLevel: 'debug' })],
};
ignorewebpack.config.js
module.exports = {
plugins: [new CopyPlugin([...patterns], { ignore: ['*.js', '*.css'] })],
};
contextwebpack.config.js
module.exports = {
plugins: [new CopyPlugin([...patterns], { context: '/app' })],
};
copyUnmodifiedℹ️ By default, we only copy modified files during a
webpack --watchorwebpack-dev-serverbuild. Setting this option totruewill copy all files.
webpack.config.js
module.exports = {
plugins: [new CopyPlugin([...patterns], { copyUnmodified: true })],
};
Please take a moment to read our contributing guidelines if you haven't yet done so.
FAQs
Copy files && directories with webpack
The npm package copy-webpack-plugin receives a total of 7,850,040 weekly downloads. As such, copy-webpack-plugin popularity was classified as popular.
We found that copy-webpack-plugin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.