unused-files-webpack-plugin

unused-files-webpack-plugin

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

Installation

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

Usage

// webpack.config.js
var UnusedFilesWebpackPlugin = require("unused-files-webpack-plugin");

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

Options

new UnusedFilesWebpackPlugin(options)

options.pattern

The pattern to glob all files within the context.

• Default: **/*.*
• Directly pass to glob(pattern)

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.

• Default: {ignore: "node_modules/**/*"}
• Directly pass to glob(pattern, 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

Changelog

2.0.0 (2016-01-22)

Features

• src: rewrite in ES2015 format (9a61f21)

BREAKING CHANGES

• src: Removes commonjs module support.

Before:

// webpack.config.js
var UnusedFilesWebpackPlugin = require("unused-files-webpack-plugin");

After:

In ES2015 module format:

import UnusedFilesWebpackPlugin from "unused-files-webpack-plugin";
// it's the same as
import { default as UnusedFilesWebpackPlugin } from "unused-files-webpack-plugin";
// You could access from named export as well.
import { UnusedFilesWebpackPlugin } from "unused-files-webpack-plugin";

If you still use commonjs:

var UnusedFilesWebpackPlugin = require("unused-files-webpack-plugin").default;
// or named export
var UnusedFilesWebpackPlugin = require("unused-files-webpack-plugin").UnusedFilesWebpackPlugin;
// with destructive assignment
var { UnusedFilesWebpackPlugin } = require("unused-files-webpack-plugin");

<a name"1.3.0"></a>