Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
webpack-common-shake
Advanced tools
Please file an issue if anything is broken.
See common-shake for abstract bundler-independent implementation.
NOTE: webpack version 4 may be needed in order to run this.
If you're using webpack 3, please use webpack-common-shake@1.x
.
NOTE: Logo is a modified version of webpack's logo
There are vast amount of CommonJS modules out there. Thus CommonJS Tree Shaking is as important as the ESM module import/export shaking.
This plugin removes unused assignments to exports
properties leaving removal
of the (presumably) dead code to UglifyJS. If, for example, you had a module:
exports.used = 1;
var tmp = exports.unused = 2;
This plugin will transform it to:
exports.used = 1;
var tmp = 2;
It is up to UglifyJS (or some other optimizer) to decide, whether tmp
is used
or not and delete it. Luckily it is much simpler for it to do if the uses are
not clouded by exporting the values.
Example webpack.config.js
:
const ShakePlugin = require('webpack-common-shake').Plugin;
module.exports = [{
entry: 'entry.js'
output: {
path: 'dist',
filename: 'output.js'
},
plugins: [ new ShakePlugin() ]
}];
See webpack-common-shake-demo for size comparison of output with and without this plugin.
Plugin constructor accepts options
object which may have following properties:
const plugin = new ShakePlugin({
warnings: {
global: true,
module: false
} /* default */,
// Invoked on every deleted unused property
onExportDelete: (resource, property) => {},
// See `Limitations` section for description
onModuleBailout: (module, bailouts) => { ... },
onGlobalBailout: (bailouts) => { ... }
});
Although, generally this module works and helps removing unused code from the
bundles. There are some limitations that may prevent it from running either
partially or completely. Some examples are provided below, otherwise please use
common sense (or onModuleBailout
, onGlobalBailout
plugin options).
Some local (partial) bailouts:
exports[Math.random()] = ...
var a = require('./a'); a.lib; a = require('./b')
require
in unknown way console.log(require('./lib'))
require
dynamically { [prop]: name } = require('./a')
var fn = require('./lib')[Math.random()]
Some global (full) bailouts:
require(Math.random())
This plugin will print some webpack warnings. In any case, bailouts may be obtained programmatically too:
const plugin = new ShakePlugin({
onModuleBailout: (module, bailouts) => { ... },
onGlobalBailout: (bailouts) => { ... }
});
For debugging and inspection purposes a graph in dot format may be
obtained using onGraph
option:
const plugin = new ShakePlugin({
onGraph: (graph) => { ... }
});
This software is licensed under the MIT License.
Copyright Fedor Indutny, 2017.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
CommonJS Tree Shake Plugin for Webpack
We found that webpack-common-shake demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers 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.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.