clean-webpack-plugin
Advanced tools
Package description
The clean-webpack-plugin is a plugin for webpack, a module bundler for JavaScript. It is used to remove/clean your build folder(s) before building. This ensures that only used files are generated when your project is built, preventing the accumulation of outdated files from previous builds.
Removing all files inside webpack's output.path directory
This feature automatically cleans up the output directory specified in webpack's configuration before each build, ensuring that only the files generated in the current build are present.
const { CleanWebpackPlugin } = require('clean-webpack-plugin');
module.exports = {
plugins: [
new CleanWebpackPlugin(),
],
};Preserving specific files or directories during clean
This feature allows you to exclude specific files or directories from being deleted when the output directory is cleaned. This is useful for cases where you want to keep certain files across builds.
const { CleanWebpackPlugin } = require('clean-webpack-plugin');
module.exports = {
plugins: [
new CleanWebpackPlugin({
cleanOnceBeforeBuildPatterns: ['**/*', '!static-files*'],
cleanStaleWebpackAssets: false,
protectWebpackAssets: false
}),
],
};Rimraf is a deep deletion module for node (like `rm -rf`). It's not specifically tied to webpack but can be used in npm scripts or directly in node scripts to clean directories. It's simpler but requires manual configuration compared to clean-webpack-plugin's integration with webpack.
Del is another package for deleting files and directories. Similar to rimraf, it's used in build processes but isn't tied to webpack. It provides more control over what to delete through glob patterns and options but lacks the direct webpack integration that clean-webpack-plugin offers.
Readme
A webpack plugin to remove/clean your build folder(s) before building
npm install clean-webpack-plugin --save-dev
var CleanWebpackPlugin = require('clean-webpack-plugin');
module.exports = {
plugins: [
new CleanWebpackPlugin(['dist', 'build'], {
root: '/full/project/path',
verbose: true,
dry: false
})
]
}
new CleanWebpackPlugin(paths [, {options}])
An [array] of string paths to clean
['dist', 'build']
{
"root": "[location of webpack.config]", // An absolute path for the root.
"verbose": true, // Write logs to console.
"dry": false, // Do not delete anything, good for testing.
}
FAQs
A webpack plugin to remove/clean your build folder(s).
The npm package clean-webpack-plugin receives a total of 1,140,070 weekly downloads. As such, clean-webpack-plugin popularity was classified as popular.
We found that clean-webpack-plugin demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.
Security News
The NVD is facing a significant backlog with over 12,500 CVEs awaiting analysis, and more than 50% of known exploited vulnerabilities (KEVs) left unenriched since mid-February.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.