Registry / devops / vite-plugin-clean-build

vite-plugin-clean-build

library1.4.1jsnpmunverified

vite-plugin-clean-build is a Vite plugin designed to remove or clean specified files and directories after the build process completes. It is currently at version 1.4.1 and maintains an active release cadence, with frequent minor updates addressing bug fixes, performance optimizations, and compatibility with new Vite versions (e.g., supporting Vite 5.0 and 6.0 in recent releases). Key differentiators include its straightforward configuration for specifying an `outputDir` and glob patterns for removal, alongside an optional verbose logging mode to track deleted files. This plugin is particularly useful for tasks such as cleaning up temporary assets, specific cache directories, or unwanted build artifacts that Vite's default build process might leave behind, ensuring a leaner and more controlled final build output.

devops

npm install vite-plugin-clean-build

github ↗package ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-CLEAN-

vite-plugin-clean-build

devopsjavascriptv1.4.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–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

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

CleanBuild

✓ import CleanBuild from 'vite-plugin-clean-build';

✗ const CleanBuild = require('vite-plugin-clean-build');

Vite configuration files are typically ESM, so `import` syntax is standard. The plugin exports a default function.

CleanBuild (invocation)

✓ plugins: [CleanBuild()]

✗ plugins: [CleanBuild]

The imported `CleanBuild` is a function that must be called (invoked) to return the plugin instance for Vite's `plugins` array.

Options (type)

✓ import type { Options } from 'vite-plugin-clean-build';

✗ import { Options } from 'vite-plugin-clean-build';

For TypeScript, explicitly importing `Options` as a type ensures it's only used for type-checking and no runtime import is generated.

This quickstart demonstrates how to integrate `vite-plugin-clean-build` into a Vite configuration, specifying custom output directories and glob patterns for cleaning, along with verbose logging, and showing how to import the configuration type for type-safety.

import { defineConfig } from 'vite'; import CleanBuild from 'vite-plugin-clean-build'; import type { Options } from 'vite-plugin-clean-build'; // Demonstrate type import const cleanBuildOptions: Options = { outputDir: 'dist', // Default, but explicit for clarity patterns: [ 'images/**', // Clean all images within 'dist/images' '!images/logo.png',// Except the logo file in 'dist/images' 'temp/*' // Also clean temporary files in 'dist/temp' ], verbose: true, // Log deleted files to console }; export default defineConfig({ plugins: [ CleanBuild(cleanBuildOptions), ], build: { outDir: cleanBuildOptions.outputDir, // Ensure Vite builds to the same directory }, });

Debug

Known issues

breakingThe plugin's minor versions often align with new Vite major versions. For instance, v1.2.1 supports Vite 5.0, and v1.3.0 supports Vite 6.0. Using an incompatible plugin version with your Vite installation can lead to build failures or unexpected behavior.

fix

Always ensure your `vite-plugin-clean-build` version is compatible with your installed `vite` version, referring to the plugin's release notes for specific compatibility matrix.

affects: >=1.2.1

gotchaBy default, `vite-plugin-clean-build` targets the `dist` directory. If your Vite project uses a different `build.outDir`, you must explicitly configure the `outputDir` option to match it, otherwise, the plugin will clean the wrong directory or do nothing.

fix

Set `outputDir` in the plugin configuration to match your `vite.config.ts`'s `build.outDir` (e.g., `outputDir: 'my-custom-output'`).

affects: *

gotchaThe `patterns` option uses `glob` syntax. Ensure you understand how glob patterns work, especially for negation (`!`) and directory matching, to avoid accidentally deleting critical files or failing to delete intended ones. Patterns are relative to `outputDir`.

fix

Test your glob patterns carefully, perhaps using a dedicated glob testing tool, and start with `verbose: true` in the plugin options to confirm what files are being targeted for deletion.

affects: *

gotchaThe cleaning process occurs after Vite's build step completes. If subsequent build processes or scripts rely on intermediate files in the output directory, those files might be removed before they can be used.

fix

Plan your build pipeline carefully, ensuring that `vite-plugin-clean-build` runs at an appropriate stage, typically as the very last step involving the build output, or adjust your dependent scripts.

affects: *

Errors

Common errors & fixes

TypeError: (0 , vite_plugin_clean_build_1.default) is not a function

The imported `CleanBuild` function was not invoked with `()` when added to the `plugins` array.

fix

Ensure the plugin is called: `plugins: [CleanBuild()]` instead of `plugins: [CleanBuild]`.

[vite-plugin-clean-build] The output directory 'dist' does not exist.

The `outputDir` configured in the plugin does not match Vite's actual `build.outDir`, or the build failed before creating the directory.

fix

Ensure `outputDir` in the plugin options precisely matches `build.outDir` in your Vite configuration. Verify that your Vite build completes successfully.

Could not resolve "vite-plugin-clean-build" from "vite.config.ts"

The `vite-plugin-clean-build` package is not installed or incorrectly installed in your project's `node_modules`.

fix

Run `npm install vite-plugin-clean-build -D`, `yarn add vite-plugin-clean-build -D`, or `pnpm add vite-plugin-clean-build -D` to install the package as a dev dependency.

Plugin "vite-plugin-clean-build" requires Vite version ">=3.0.0", but you are running "2.x.x".

Your installed `vite` version does not meet the peer dependency requirement of `vite-plugin-clean-build`.

fix

Upgrade your Vite installation to a compatible version (e.g., `npm update vite`) or, if necessary, downgrade `vite-plugin-clean-build` to a version compatible with your current Vite installation.

Upgrade

Version history

1.4.1latest on npm

Audit

Dependencies

viterequiredThis is a Vite plugin and requires Vite to be installed as a peer dependency for proper integration with the build system.

Agent activity

9 hits · last 30 days

node

OpenAI (training)

Bingbot

Resources

githubhttps://github.com/oyjt/vite-plugin-clean-build ↗

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