tomchentw/unused-files-webpack-plugin

Glob all files that are not compiled by webpack under webpack's context

unused-files-webpack-plugin

Glob all files that are not compiled by webpack under webpack's context

Install with npm:

npm i --save-dev unused-files-webpack-plugin

Install with yarn:

yarn add --dev unused-files-webpack-plugin

Usage

webpack.config.babel.js

import UnusedFilesWebpackPlugin from "unused-files-webpack-plugin";

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

webpack.config.js

const { UnusedFilesWebpackPlugin } = require("unused-files-webpack-plugin");

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

Options

new UnusedFilesWebpackPlugin(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

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