rollup-plugin-copy

Copy files and folders, with glob support.

Installation

1# yarn
2yarn add rollup-plugin-copy -D
3
4# npm
5npm install rollup-plugin-copy -D

Usage

1// rollup.config.js
2import copy from 'rollup-plugin-copy'
3
4export default {
5  input: 'src/index.js',
6  output: {
7    file: 'dist/app.js',
8    format: 'cjs'
9  },
10  plugins: [
11    copy({
12      targets: [
13        { src: 'src/index.html', dest: 'dist/public' },
14        { src: ['assets/fonts/arial.woff', 'assets/fonts/arial.woff2'], dest: 'dist/public/fonts' },
15        { src: 'assets/images/**/*', dest: 'dist/public/images' }
16      ]
17    })
18  ]
19}

Configuration

There are some useful options:

targets

Type: Array | Default: []

Array of targets to copy. A target is an object with properties:

• src (string Array): Path or glob of what to copy
• dest (string Array): One or more destinations where to copy
• rename (string Function): Change destination file or folder name
• transform (Function): Modify file contents

Each object should have src and dest properties, rename and transform are optional. globby is used inside, check it for glob pattern examples.

File

1copy({
2  targets: [{ src: 'src/index.html', dest: 'dist/public' }]
3})

Folder

1copy({
2  targets: [{ src: 'assets/images', dest: 'dist/public' }]
3})

Glob

1copy({
2  targets: [{ src: 'assets/*', dest: 'dist/public' }]
3})

Glob: multiple items

1copy({
2  targets: [{ src: ['src/index.html', 'src/styles.css', 'assets/images'], dest: 'dist/public' }]
3})

Glob: negated patterns

1copy({
2  targets: [{ src: ['assets/images/**/*', '!**/*.gif'], dest: 'dist/public/images' }]
3})

Multiple targets

1copy({
2  targets: [
3    { src: 'src/index.html', dest: 'dist/public' },
4    { src: 'assets/images/**/*', dest: 'dist/public/images' }
5  ]
6})

Multiple destinations

1copy({
2  targets: [{ src: 'src/index.html', dest: ['dist/public', 'build/public'] }]
3})

Rename with a string

1copy({
2  targets: [{ src: 'src/app.html', dest: 'dist/public', rename: 'index.html' }]
3})

Rename with a function

1copy({
2  targets: [{
3    src: 'assets/docs/*',
4    dest: 'dist/public/docs',
5    rename: (name, extension, fullPath) => `${name}-v1.${extension}`
6  }]
7})

Transform file contents

1copy({
2  targets: [{
3    src: 'src/index.html',
4    dest: 'dist/public',
5    transform: (contents, filename) => contents.toString().replace('__SCRIPT__', 'app.js')
6  }]
7})

verbose

Type: boolean | Default: false

Output copied items to console.

1copy({
2  targets: [{ src: 'assets/*', dest: 'dist/public' }],
3  verbose: true
4})

hook

Type: string | Default: buildEnd

Rollup hook the plugin should use. By default, plugin runs when rollup has finished bundling, before bundle is written to disk.

1copy({
2  targets: [{ src: 'assets/*', dest: 'dist/public' }],
3  hook: 'writeBundle'
4})

copyOnce

Type: boolean | Default: false

Copy items once. Useful in watch mode.

1copy({
2  targets: [{ src: 'assets/*', dest: 'dist/public' }],
3  copyOnce: true
4})
5

copySync

Type: boolean | Default: false

Copy items synchronous.

1copy({
2  targets: [{ src: 'assets/*', dest: 'dist/public' }],
3  copySync: true
4})

flatten

Type: boolean | Default: true

Remove the directory structure of copied files.

1copy({
2  targets: [{ src: 'assets/**/*', dest: 'dist/public' }],
3  flatten: false
4})

All other options are passed to packages, used inside:

• globby
• fs-extra copy function

Original Author

Cédric Meuter

License

MIT