@barretter/remove-unused-files-webpack-plugin

remove-unused-files-webpack-plugin

fork from unused-files-webpack-plugin。The main extension is to remove unused files.

Install with npm:

npm i --save-dev @barretter/remove-unused-files-webpack-plugin

Install with yarn:

yarn add --dev @barretter/remove-unused-files-webpack-plugin

Usage

webpack.config.babel.js

import RemoveUnusedFilesWebpackPlugin from "@barretter/remove-unused-files-webpack-plugin";

export default {
  plugins: [
    new RemoveUnusedFilesWebpackPlugin(options),
  ],
};

webpack.config.js

const RemoveUnusedFilesWebpackPlugin = require("@barretter/remove-unused-files-webpack-plugin").default;

module.exports = {
  plugins: [
    new RemoveUnusedFilesWebpackPlugin(options),
  ],
};

Options

new RemoveUnusedFilesWebpackPlugin(options)

options.patterns

The (array of) pattern(s) to glob all files within the context.

• Default: ["**/*.*"]
• Directly pass to glob-all(patterns)

options.failOnUnused

Emit error instead of warning in webpack compilation result.

• Default: false
• Explicitly set it to true to enable this feature

options.globOptions

The options object pass to second parameter of glob-all.

• Default: {ignore: "node_modules/**/*"}
• Directly pass to glob-all(pattern, globOptions), which then pass to glob(…, globOptions)

globOptions.ignore

Ignore pattern for glob. Can be a String or an Array of String.

• Default: "node_modules/**/*"
• Pass to: options.ignore

globOptions.cwd

Current working directory for glob. If you don't set explicitly, it defaults to the context specified by your webpack compiler at runtime.

• Default: webpackCompiler.context
• Pass to: options.cwd
• See also: context in webpack

options.removeToBackup

Whether to move unused files to the backup folder. Use this feature with caution.

• Default: false
• Explicitly set it to true to enable this feature

backupOptions.backUpDirPath

Backup folder Path.

• Default: ./.backup
• Only removeToBackup configuration to be true, This configuration item is valid.

backupOptions.backUpDirname

Backup folder name.

• Default: The time when you run this plugin
• Only removeToBackup configuration to be true, This configuration item is valid.

backupOptions.overwrite

Whether to overwrite older files when the backup folder exit the same file

• Default: false
• Explicitly set it to true to enable this feature
• Only removeToBackup configuration to be true, This configuration item is valid.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request