Registry / devops / vite-plugin-clean

vite-plugin-clean

library2.0.1jsnpmunverified

Vite plugin to remove/clean build files or folders before building. Version 2.0.1, maintained with sparse releases. Key differentiator: simple, zero-config clean of 'dist' by default with optional custom target files. Lightweight alternative to 'rimraf' or shell commands, integrates directly into Vite's build lifecycle. No extra dependencies.

devops

npm install vite-plugin-clean

github ↗package ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-CLEAN

vite-plugin-clean

devopsjavascriptv2.0.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default import (cleanPlugin)

✓ import cleanPlugin from 'vite-plugin-clean'

✗ const cleanPlugin = require('vite-plugin-clean')

ESM only; supports default export.

default import (alias)

✓ import clean from 'vite-plugin-clean'

✗ import { clean } from 'vite-plugin-clean'

The module exports a default function only.

TypeScript support

✓ import cleanPlugin from 'vite-plugin-clean'

Ships TypeScript types; no separate type import needed.

Demonstrates plugin usage with custom targetFiles to remove 'dist' and 'temp' directories before build.

// vite.config.js import { defineConfig } from 'vite' import cleanPlugin from 'vite-plugin-clean' export default defineConfig({ plugins: [ cleanPlugin({ targetFiles: ['dist', 'temp'] }) ] })

Debug

Known issues

gotchaPlugin cleans target files before every build, including dev server start.

fix

Ensure target files are not needed during dev; consider using 'buildStart' only by wrapping in conditional.

affects: >=1.0.0

gotchatargetFiles are deleted synchronously and irreversibly.

fix

Double-check file paths; test with non-critical directories first.

affects: >=1.0.0

deprecatedOption 'cleanDist' removed in v2.0.0.

fix

Use targetFiles: ['dist'] instead.

affects: >=2.0.0

Errors

Common errors & fixes

Error: Cannot find module 'vite-plugin-clean'

Missing npm install or mismatched package name.

fix

Run `npm install --save-dev vite-plugin-clean`

TypeError: cleanPlugin is not a function

Incorrect import style (named instead of default).

fix

Use `import cleanPlugin from 'vite-plugin-clean'` (default import).

Clean plugin not working: nothing is deleted.

targetFiles paths are relative to project root but might be incorrect.

fix

Use absolute paths or ensure relative paths are correct from project root.

Upgrade

Version history

2.0.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/z-ti/vite-plugin-clean ↗

packagehttps://www.npmjs.com/package/vite-plugin-clean ↗