remove-files-webpack-plugin
Advanced tools
A plugin for webpack that removes files and folders before and after compilation.
A plugin for webpack that removes files and folders before and after compilation.
npm:npm install remove-files-webpack-plugin
yarn:yarn add remove-files-webpack-plugin
The plugin works on any OS and webpack >= 2.2.0.
const RemovePlugin = require('remove-files-webpack-plugin');
module.exports = {
plugins: [
new RemovePlugin({
before: {
// parameters for "before normal compilation" stage.
},
watch: {
// parameters for "before watch compilation" stage.
},
after: {
// parameters for "after normal and watch compilation" stage.
}
})
]
};
JavaScript uses it for escaping. If you want to use backward slash, then use double backward slash. Example: C:\\Windows\\System32\\cmd.exe. By the way, single forward slashes are also supported.
All paths that you get or see from the plugin will contain platform-specific segment separator (i.e. slash): \\ on Windows and / on POSIX. So, for example, even if you passed folders or files with / as separator, TestObject.method will give you a path with \\ as segment separator.
From Node.js documentation:
On Windows Node.js follows the concept of per-drive working directory. This behavior can be observed when using a drive path without a backslash. For example,
path.resolve('c:\\')can potentially return a different result thanpath.resolve('c:'). For more information, see this MSDN page.
| Name | Type | Default | Description |
|---|---|---|---|
| root | string | . | A root directory. Not absolute paths will be appended to this. Defaults to where package.json and node_modules are located. |
| include | string[] | [] | A folders and files for removing. |
| exclude | string[] | [] | A folders and files for excluding. |
| test | TestObject[] | [] | A folders for testing. |
| TestObject.folder | string | Required | A path to the folder (relative to root). |
| TestObject.method | (absolutePath: string) => boolean | Required | A method that accepts an item path (root + folderPath + fileName) andreturns value that indicates should this item be removed or not. |
| TestObject.recursive | boolean | false | Apply this method to all items in subdirectories. |
| beforeRemove | (absoluteFoldersPaths: string[],absoluteFilesPaths: string[]) => boolean | undefined | If specified, will be called before removing. Absolute paths of folders and files that will be removed will be passed into this function. If returned value is true,then remove process will be canceled. Will be not called if emulate is on. |
| afterRemove | (absoluteFoldersPaths: string[],absoluteFilesPaths: string[]) => void | undefined | If specified, will be called after removing. Absolute paths of folders and files that have been removed will be passed into this function. |
| trash | boolean | false | Move folders and files to trash (recycle bin) instead of permanent removing. Requires Windows 8+, macOS 10.12+ or Linux. |
| log | boolean | true | Print messages of "info" level (example: "Which folders or files have been removed"). |
| logWarning | boolean | true | Print messages of "warning" level (example: "An items for removing not found"). |
| logError | boolean | false | Print messages of "error" level (example: "No such file or directory"). |
| logDebug | boolean | false | Print messages of "debug" level (used for debugging). |
| emulate | boolean | false | Emulate remove process. Print which folders and files will be removed without actually removing them. Ignores log parameter. |
| allowRootAndOutside | boolean | false | Allow removing of root directory or outside root directory.It is kind of safe mode. Don't turn it on if you don't know what you actually do! |
You can pass these parameters into any of the following keys: before, watch or after. Each key is optional, but at least one should be specified.
before – executes once before "normal" compilation;watch – executes every time before "watch" compilation;after – executes once after "normal" compilation and every time after "watch" compilation.new RemovePlugin({
/**
* Before compilation permanently removes
* entire `./dist` folder.
*/
before: {
include: [
'./dist'
]
}
})
new RemovePlugin({
/**
* Every time before "watch" compilation
* permanently removes `./dist/js/entry.js` file.
*/
watch: {
include: [
'./dist/js/entry.js'
]
}
})
new RemovePlugin({
/**
* After compilation removes both
* `./dist/manifest.json` file and
* `./dist/maps` folder to trash.
*/
after: {
root: './dist',
include: [
'manifest.json',
'maps'
],
trash: true
}
})
new RemovePlugin({
/**
* Before compilation permanently removes both
* `./dist/manifest.json` file and `./dist/maps` folder.
* Log only works for warnings and errors.
*/
before: {
include: [
'dist/manifest.json',
'./dist/maps'
],
log: false,
logWarning: true,
logError: true,
logDebug: false
}
})
new RemovePlugin({
/**
* After compilation permanently removes
* all maps files in `./dist/styles` folder and
* all subfolders (e.g. `./dist/styles/header`).
*/
after: {
test: [
{
folder: 'dist/styles',
method: (absoluteItemPath) => {
return new RegExp(/\.map$/, 'm').test(absoluteItemPath);
},
recursive: true
}
]
}
})
new RemovePlugin({
/**
* After compilation:
* - permanently removes all css maps in `./dist/styles` folder.
* - permanently removes all js maps in `./dist/scripts` folder and
* all subfolders (e.g. `./dist/scripts/header`).
*/
after: {
root: './dist',
test: [
{
folder: './styles',
method: (absoluteItemPath) => {
return new RegExp(/\.css\.map$/, 'm').test(absoluteItemPath);
}
},
{
folder: './scripts',
method: (absoluteItemPath) => {
return new RegExp(/\.js\.map$/, 'm').test(absoluteItemPath);
},
recursive: true
}
]
}
})
new RemovePlugin({
/**
* Before compilation permanently removes all
* folders, subfolders and files from `./dist/maps`
* except `./dist/maps/main.map.js` file.
*/
before: {
root: './dist'
/**
* You should do like this
* instead of `include: ['./maps']`.
*/
test: [
{
folder: './maps',
method: () => true,
recursive: true
}
],
exclude: [
'./maps/main.map.js'
]
},
/**
* After compilation permanently removes
* all css maps in `./dist/styles` folder
* except `popup.css.map` file.
*/
after: {
test: [
{
folder: 'dist/styles',
method: (absoluteItemPath) => {
return new RegExp(/\.css\.map$/, 'm').test(absoluteItemPath);
}
}
],
exclude: [
'dist/styles/popup.css.map'
]
}
})
new RemovePlugin({
/**
* Before "normal" compilation permanently
* removes entire `./dist` folder.
*/
before: {
include: [
'./dist'
]
},
/**
* Every time before compilation in "watch"
* mode (`webpack --watch`) permanently removes JS files
* with hash in the name (like "entry-vqlr39sdvl12.js").
*/
watch: {
test: [
{
folder: './dist/js',
method: (absPath) => new RegExp(/(.*)-([^-\\\/]+)\.js/).test(absPath)
}
]
},
/**
* Once after "normal" compilation or every time
* after "watch" compilation removes `./dist/log.txt`
* file in trash.
*/
after: {
include: [
'./dist/log.txt'
],
trash: true
}
})
new RemovePlugin({
/**
* Before compilation emulates remove process
* for a file that is outside of the root directory.
* That file will be removed in trash in case of
* not emulation.
*/
before: {
root: '.', // "D:\\remove-files-webpack-plugin-master"
include: [
"C:\\Desktop\\test.txt"
],
trash: true,
emulate: true,
allowRootAndOutside: true
}
})
new RemovePlugin({
/**
* After compilation grabs all files from
* all subdirectories and decides should
* remove process be continued or not.
* If removed process is continued,
* then logs results with custom logger.
*/
after: {
root: './dist',
test: [
{
folder: '.',
method: () => true,
recursive: true
}
],
beforeRemove: (absoluteFoldersPaths, absoluteFilesPaths) => {
// cancel removing if there at least one folder.
if (absoluteFoldersPaths.length) {
return true;
}
// cancel removing if there at least one `.txt` file.
for (const item of absoluteFilesPaths) {
if (item.includes('.txt')) {
return true;
}
}
},
afterRemove: (absoluteFoldersPaths, absoluteFilesPaths) => {
// replacing plugin logger with custom logger.
console.log('Successfully removed:');
console.log(`Folders – [${absoluteFoldersPaths}]`);
console.log(`Files – [${absoluteFilesPaths}]`);
},
log: false
}
})
Feel free to use issues. Pull requests are also always welcome!
MIT.
1.4.0 (February 27, 2020)
watch. Parameters of that key will be applied in "watch" mode. Parameters of before key will no longer be applied in "watch" mode. So, make sure your current configuration still have expected behavior. #22include and old exclude were mixed with new include and exclude in "watch" mode. It had no effect, because the plugin checks an items for existence before removing. Just strange messages were presented in warning log.FAQs
A plugin for webpack that removes files and folders before and after compilation.
The npm package remove-files-webpack-plugin receives a total of 22,096 weekly downloads. As such, remove-files-webpack-plugin popularity was classified as popular.
We found that remove-files-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.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.