# npm

Miss any of our Open RFC calls?Watch the recordings here! »

## copy-webpack-plugin

6.3.2 • Public • Published

# copy-webpack-plugin

Copies individual files or entire directories, which already exist, to the build directory.

## Getting Started

To begin, you'll need to install copy-webpack-plugin:

Then add the plugin to your webpack config. For example:

webpack.config.js

ℹ️ webpack-copy-plugin is not designed to copy files generated from the build process; rather, it is to copy files that already exist in the source tree, as part of the build process.

ℹ️ If you want webpack-dev-server to write files to the output directory during development, you can force it with the writeToDisk option or the write-file-webpack-plugin.

ℹ️ You can get the original source filename from Asset Objects.

## Options

The plugin's signature:

webpack.config.js

### Patterns

Name Type Default Description
from {String} undefined Glob or path from where we сopy files.
to {String} compiler.options.output Output path.
context {String} options.context \|\| compiler.options.context A path that determines how to interpret the from path.
globOptions {Object} undefined Options passed to the glob pattern matching library including ignore option.
filter {Function} undefined Allows to filter copied assets.
toType {String} undefined Determinate what is to option - directory, file or template.
force {Boolean} false Overwrites files already in compilation.assets (usually added by other plugins/loaders).
flatten {Boolean} false Removes all directory references and only copies file names.
transform {Function} undefined Allows to modify the file contents.
cacheTransform {Boolean\|String\|Object} false Enable transform caching. You can use { cache: { key: 'my-cache-key' } } to invalidate the cache.
transformPath {Function} undefined Allows to modify the writing path.
noErrorOnMissing {Boolean} false Doesn't generate an error on missing file(s).

#### from

Type: String Default: undefined

Glob or path from where we сopy files. Globs accept fast-glob pattern-syntax. Glob can only be a string.

⚠️ Don't use directly \\ in from option if it is a glob (i.e path\to\file.ext) option because on UNIX the backslash is a valid character inside a path component, i.e., it's not a separator. On Windows, the forward slash and the backward slash are both separators. Instead please use /.

webpack.config.js

##### For windows

If you define from as absolute file path or absolute folder path on Windows, you can use windows path segment (\\)

But you should always use forward-slashes in glob expressions See fast-glob manual.

The context behaves differently depending on what the from is (glob, file or dir). More examples

#### to

Type: String Default: compiler.options.output

Output path.

⚠️ Don't use directly \\ in to (i.e path\to\dest) option because on UNIX the backslash is a valid character inside a path component, i.e., it's not a separator. On Windows, the forward slash and the backward slash are both separators. Instead please use / or path methods.

webpack.config.js

#### context

Type: String Default: options.context|compiler.options.context

A path that determines how to interpret the from path.

⚠️ Don't use directly \\ in context (i.e path\to\context) option because on UNIX the backslash is a valid character inside a path component, i.e., it's not a separator. On Windows, the forward slash and the backward slash are both separators. Instead please use / or path methods.

webpack.config.js

The context option can be an absolute or relative path. If context is a relative, then it is converted to absolute based to compiler.options.context

Also, context indicates how to interpret the search results. Further, he is considered in this role.

To determine the structure from which the found resources will be copied to the destination folder, the context option is used.

If from is a file, then context is equal to the directory in which this file is located. Accordingly, the result will be only the file name.

If from is a directory, then context is the same as from and is equal to the directory itself. In this case, the result will be a hierarchical structure of the found folders and files relative to the specified directory.

If from is a glob, then regardless of the context option, the result will be the structure specified in the from option

#### globOptions

Type: Object Default: undefined

Allows to configute the glob pattern matching library used by the plugin. See the list of supported options To exclude files from the selection, you should use globOptions.ignore option

webpack.config.js

#### filter

Type: Function Default: undefined

ℹ️ To ignore files by path please use the [globOptions.ignore]((#globoptions) option.

webpack.config.js

#### toType

Type: String Default: undefined

Determinate what is to option - directory, file or template. Sometimes it is hard to say what is to, example path/to/dir-with.ext. If you want to copy files in directory you need use dir option. We try to automatically determine the type so you most likely do not need this option.

Name Type Default Description
'dir' {String} undefined If to has no extension or ends on '/'
'file' {String} undefined If to is not a directory and is not a template
'template' {String} undefined If to contains a template pattern
##### 'dir'

webpack.config.js

##### 'file'

webpack.config.js

##### 'template'

webpack.config.js

#### force

Type: Boolean Default: false

Overwrites files already in compilation.assets (usually added by other plugins/loaders).

webpack.config.js

#### flatten

Type: Boolean Default: false

Removes all directory references and only copies file names.

⚠️ If files have the same name, the result is non-deterministic.

webpack.config.js

#### transform

Type: Function Default: undefined

Allows to modify the file contents.

webpack.config.js

webpack.config.js

#### cacheTransform

Type: Boolean|String|Object Default: false

Enable/disable and configure caching. Default path to cache directory: node_modules/.cache/copy-webpack-plugin.

##### Boolean

Enables/Disable transform caching.

webpack.config.js

##### String

Enables transform caching and setup cache directory.

webpack.config.js

##### Object

Enables transform caching and setup cache directory and invalidation keys.

webpack.config.js

You can setup invalidation keys using a function.

Simple function:

webpack.config.js

Async function:

webpack.config.js

#### transformPath

Type: Function Default: undefined

Allows to modify the writing path.

⚠️ Don't return directly \\ in transformPath (i.e path\to\newFile) option because on UNIX the backslash is a valid character inside a path component, i.e., it's not a separator. On Windows, the forward slash and the backward slash are both separators. Instead please use / or path methods.

webpack.config.js

webpack.config.js

### noErrorOnMissing

Type: Boolean Default: false

Doesn't generate an error on missing file(s);

### Options

Name Type Default Description
concurrency {Number} 100 Limits the number of simultaneous requests to fs

#### concurrency

limits the number of simultaneous requests to fs

webpack.config.js

### Examples

#### Different variants from (glob, file or dir).

Take for example the following file structure:

src/directory-nested/deep-nested/deepnested-file.txt
src/directory-nested/nested-file.txt

##### From is a Glob

Everything that you specify in from will be included in the result:

webpack.config.js

Result:

If you want only content src/directory-nested/, you should only indicate glob in from. The path to the folder in which the search should take place, should be moved to context.

webpack.config.js

Result:

##### From is a Dir

webpack.config.js

Result:

Technically, this is **/* with a predefined context equal to the specified directory.

webpack.config.js

Result:

##### From is a File

Result:

Technically, this is a filename with a predefined context equal to path.dirname(pathToFile).

webpack.config.js

Result:

#### Ignoring files

webpack.config.js

## Contributing

Please take a moment to read our contributing guidelines if you haven't yet done so.

CONTRIBUTING

MIT

## Keywords

### Install

npm i copy-webpack-plugin

4,316,172

6.3.2

MIT

75.1 kB

8

### Homepage

github.com/webpack-contrib/copy-webpack-plugin

### Repository

github.com/webpack-contrib/copy-webpack-plugin