vladshcherbin/rollup-plugin-delete

README

rollup-plugin-delete

Delete files and folders using Rollup.

About

This plugin is useful when you want to clean dist or other folders and files before bundling. It's using del package inside, check it for pattern examples and additional options.

Installation

# pnpm
pnpm add rollup-plugin-delete -D

# yarn
yarn add rollup-plugin-delete -D

# npm
npm install rollup-plugin-delete -D

Usage

// rollup.config.js
import del from 'rollup-plugin-delete'

export default {
  input: 'src/index.js',
  output: {
    file: 'dist/app.js'
  },
  plugins: [
    del({ targets: 'dist' })
  ]
}

Configuration

There are some useful options:

targets

A string or an array of patterns of files and folders to be deleted. Default is [].

// Folder
del({
  targets: 'build'
})

// Files
del({
  targets: 'dist/*.js'
})

// Multiple targets
del({
  targets: ['dist/*', 'images/*.webp']
})

verbose

Output removed files and folders to console. Default is false.

Note

Use * (wildcard character) in pattern to show removed files

del({
  targets: 'dist/*',
  verbose: true
})

hook

Rollup hook the plugin should use. Default is buildStart.

del({
  targets: 'dist/*',
  hook: 'buildEnd'
})

runOnce

Type: boolean | Default: false

Delete items once. Useful in watch mode.

del({
  targets: 'dist/*',
  runOnce: true
})

All other options are passed to del package which is used inside.

License

MIT