Giter Club home page Giter Club logo

webpack-extraneous-file-cleanup-plugin's Introduction

Webpack Extraneous File Cleanup Plugin

A webpack plugin to remove unwanted files which may have been created and output due to multiple entry points

Problem

When using ExtractTextPlugin, it's not possible to generate a css file for each chunk webpack outputs, if you're using code splitting.

The only possible way to do this is to have an entry point for each top level css / less / scss file, however this will create small js files with empty webpack functions in them, which are undesirable.

This plugin removes files which are under a certain byte size, after everything has been compiled and output. It can also remove these files from your manifest.json file if you are using the webpack manifest plugin or something similar to it.

Usage

Install using npm or yarn

npm install webpack-extraneous-file-cleanup-plugin --save-dev
yarn add webpack-extraneous-file-cleanup-plugin --dev

In your webpack.config.js file:

const ExtraneousFileCleanupPlugin = require('webpack-extraneous-file-cleanup-plugin');

module.exports = {
  ...
  plugins: [
    new ExtraneousFileCleanupPlugin(opts)
  ]
}

Recommended Configuration

new ExtraneousFileCleanupPlugin({
  extensions: ['.js']
})

All Configuration Options

The ExtraneousFileCleanupPlugin accepts an object of options with the following attributes:

new ExtraneousFileCleanupPlugin({
  extensions: ['.extensions', '.to', '.whitelist'],
  minBytes: 1024,
  manifestJsonName: 'manifest.json',
  paths: ['/dist/removeFromThisPath']
})
  • extensions - a list of extensions we're allowed to analyze for their file size. Useful for not removing small .js.map files, or small .css files. Defaults to analyzing all file types.
  • minBytes - the minimum byte size a file has to meet to not be deleted. Defaults to 1024 bytes.
  • manifestJsonName - if you're outputting a manifest.json file, this plugin will also remove deleted files from the manifest. Defaults to manifest.json
  • paths - an array of strings to specify which if any paths you want to limit the searching to. If this is defined, files will only be removed from those paths.

webpack-extraneous-file-cleanup-plugin's People

Contributors

anujrnair avatar sscaff1 avatar

Watchers

James Cloos avatar Willet Vary avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.