rollup-plugin-clear-directory

1.0.0 verified Mon Apr 27 auth: no javascript

A Rollup plugin that clears the output directory before each build, ensuring a clean state and preventing leftover files from previous builds. Version 1.0.0 is the current stable release. It is a lightweight plugin with a simple configuration, allowing users to specify target directories to clear. The release cadence is low; no recent updates. Key differentiators: dedicated solely to clearing directories, unlike other plugins that bundle multiple utilities. Use with Rollup for build automation.

Common errors

error Error: ENOENT: no such file or directory, rmdir '...' ↓

cause The target directory does not exist.

fix

Create the directory before running the plugin or ensure the path is correct.

error TypeError: clearDirectory is not a function ↓

cause Incorrect import statement, e.g., using named import instead of default import.

fix

Use 'import clearDirectory from 'rollup-plugin-clear-directory';'

Warnings

gotcha The plugin clears directories synchronously before bundling starts. If you specify a non-empty target that does not exist, it may throw. ↓

fix Ensure all target directories exist or handle errors. Alternatively, use a plugin like 'rollup-plugin-delete' which creates directories if needed.

gotcha If you target the output directory configured in Rollup output, the plugin may interfere with Rollup's own directory creation. Use with caution. ↓

fix Clear before build, not during. The plugin clears before the build hook, so it should be safe, but test with your configuration.

Install

npm install rollup-plugin

yarn add rollup-plugin

pnpm add rollup-plugin

Imports

clearDirectory
wrong
```
const clearDirectory = require('rollup-plugin-clear-directory');
```
correct
```
import clearDirectory from 'rollup-plugin-clear-directory';
```
The package exports a default function, so default import is correct. CommonJS require works but is not recommended for ESM projects.

default

wrong

import { clearDirectory } from 'rollup-plugin-clear-directory';

correct

import clearDirectory from 'rollup-plugin-clear-directory';

Named import does not work because the package uses default export.

ClearOptions
```
import type { ClearOptions } from 'rollup-plugin-clear-directory';
```
TypeScript users can import the type for configuration. This is optional.

Quickstart

Demonstrates basic usage of clearing the 'dist' directory before each Rollup build.

// rollup.config.js
import clearDirectory from 'rollup-plugin-clear-directory';

export default {
  input: 'src/main.js',
  output: {
    dir: 'dist',
    format: 'esm'
  },
  plugins: [
    clearDirectory({
      targets: ['dist']
    })
  ]
};