rollup-plugin-copy-merge/readme.md

Copy & Merge files and folders using Rollup

# rollup-plugin-copy-merge

![license](https://img.shields.io/github/license/syJSdev/rollup-plugin-copy-merge)
[![npm](https://img.shields.io/npm/v/rollup-plugin-copy-merge)](https://www.npmjs.com/package/rollup-plugin-copy-merge)
[![release](https://github.com/syJSdev/rollup-plugin-copy-merge/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/syJSdev/rollup-plugin-copy-merge/actions/workflows/release.yml)
[![codecov](https://codecov.io/gh/syJSdev/rollup-plugin-copy-merge/branch/main/graph/badge.svg?token=RMODCAC64I)](https://codecov.io/gh/syJSdev/rollup-plugin-copy-merge)

Copy & Merge files and folders, with glob support.
This plugin is extended [rollup-plugin-copy](https://github.com/vladshcherbin/rollup-plugin-copy) plugin which support the merge functionality.
Thanks [#vladshcherbin](https://github.com/vladshcherbin)

## Installation

```bash
# yarn
yarn add rollup-plugin-copy-merge --dev

# npm
npm i rollup-plugin-copy-merge --save-dev
```

## Usage

```js
// rollup.config.js
import copy from 'rollup-plugin-copy-merge'

export default {
  input: 'src/index.js',
  output: {
    file: 'dist/app.js',
    format: 'cjs'
  },
  plugins: [
    copy({
      targets: [
        { src: 'src/index.html', dest: 'dist/public' },
        { src: ['assets/fonts/arial.woff', 'assets/fonts/arial.woff2'], dest: 'dist/public/fonts' },
        { src: 'assets/images/**/*', dest: 'dist/public/images' }
        { src: 'assets/js/*.js', file: 'dist/public/scripts.js' },
      ]
    })
  ]
}
```

### 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
- **file** (`string`): destination file where to copy. all source files will merge into this file. (only supports for 'utf8' contents)
- **rename** (`string`, `Function`): Change destination file or folder name
- **transform** (`Function`): Modify file contents (only supports for 'utf8' contents)

Each object should have **dest** or **file**, and **src** properties, **rename** and **transform** are optional. [globby](https://github.com/sindresorhus/globby) is used inside, check it for [glob pattern](https://github.com/sindresorhus/globby#globbing-patterns) examples.

##### Merge (extended)

Can merge using `file` attribute.

```js
copy({
  targets: [{ src: 'assets/polyfill/*.js', file: 'dist/public/polyfill.js' }],
  flatten: false
});
```

##### File

```js
copy({
  targets: [{ src: 'src/index.html', dest: 'dist/public' }]
});
```

##### Folder

```js
copy({
  targets: [{ src: 'assets/images', dest: 'dist/public' }]
});
```

##### Glob

```js
copy({
  targets: [{ src: 'assets/*', dest: 'dist/public' }]
});
```

##### Glob: multiple items

```js
copy({
  targets: [
    {
      src: ['src/index.html', 'src/styles.css', 'assets/images'],
      dest: 'dist/public'
    }
  ]
});
```

##### Glob: negated patterns

```js
copy({
  targets: [{ src: ['assets/images/**/*', '!**/*.gif'], dest: 'dist/public/images' }]
});
```

##### Multiple targets

```js
copy({
  targets: [
    { src: 'src/index.html', dest: 'dist/public' },
    { src: 'assets/images/**/*', dest: 'dist/public/images' }
  ]
});
```

##### Multiple destinations

```js
copy({
  targets: [{ src: 'src/index.html', dest: ['dist/public', 'build/public'] }]
});
```

##### Rename with a string

```js
copy({
  targets: [{ src: 'src/app.html', dest: 'dist/public', rename: 'index.html' }]
});
```

##### Rename with a function

```js
copy({
  targets: [
    {
      src: 'assets/docs/*',
      dest: 'dist/public/docs',
      rename: (name, extension, src_path) => `${name}-v1.${extension}`
    }
  ]
});
```

##### Transform file contents

```js
copy({
  targets: [
    {
      src: 'src/index.html',
      dest: 'dist/public',
      transform: (contents, src_file_name, src_path) =>
        contents.toString().replace('__SCRIPT__', 'app.js')
    }
  ]
});
```

#### verbose

Type: `boolean` | Default: `false`

Output copied items to console.

```js
copy({
  targets: [{ src: 'assets/*', dest: 'dist/public' }],
  verbose: true
});
```

#### hook

Type: `string` | Default: `buildEnd`

[Rollup hook](https://rollupjs.org/guide/en/#hooks) the plugin should use. By default, plugin runs when rollup has finished bundling, before bundle is written to disk.

```js
copy({
  targets: [{ src: 'assets/*', dest: 'dist/public' }],
  hook: 'writeBundle'
});
```

#### copyOnce

Type: `boolean` | Default: `false`

Copy items once. Useful in watch mode.

```js
copy({
  targets: [{ src: 'assets/*', dest: 'dist/public' }],
  copyOnce: true
});
```

#### flatten

Type: `boolean` | Default: `true`

Remove the directory structure of copied files.

```js
copy({
  targets: [{ src: 'assets/**/*', dest: 'dist/public' }],
  flatten: false
});
```

All other options are passed to packages, used inside:

- [globby](https://github.com/sindresorhus/globby)

## Original Author

[Cédric Meuter](https://github.com/meuter)
[Vlad Shcherbin](https://github.com/vladshcherbin)

## License

MIT