package
browserify tree shaking plugin using @indutny common-shake
npm install common-shakeifyGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
browserify tree shaking plugin based on common-shake, the CommonJS tree shaker originally by @indutny.
Comments out unused exports from CommonJS modules.
With input files:
// math.js
exports.min = function (a, b) { return a < b ? a : b }
exports.max = function (a, b) { return a < b ? b : a }
// app.js
var math = require('./math')
console.log(math.max(10, 20))This plugin will rewrite the files to:
// math.js
/* common-shake removed: exports.min = */ void function (a, b) { return a < b ? a : b }
exports.max = function (a, b) { return a < b ? b : a }
// app.js
var math = require('./math')
console.log(math.max(10, 20))Use a minifier on the output to remove the exports entirely.
npm install --save-dev common-shakeifyWith the browserify cli:
browserify -p common-shakeify /my/app.js > bundle.js
# Minify
uglify-js bundle.js --compress > bundle.min.jsWith the browserify Node API:
var commonShake = require('common-shakeify')
var b = browserify({ entries: '/my/app.js' })
.plugin(commonShake, { /* options */ })
.bundle()
// Minify & save
var uglify = require('minify-stream')
b
.pipe(uglify())
.pipe(fs.createWriteStream('bundle.min.js'))Note that using a minifier transform like uglifyify doesn't eliminate the commented-out exports. Transforms run before common-shakeify, so you have to use a minifier on the final bundle to remove the unused exports.
verbose, vWhen true, print messages to stderr when exports are deleted, or the tree-shaker bails out on a module.
Default false.
The verbose flag only works when no custom handlers are passed, so if you're using eg. a custom onExportDelete you have to print these messages manually.
$ browserify -p [ common-shakeify -v ] app.js > bundle.js
common-shake: removed `decode` in node_modules/vlq/dist/vlq.js:10:7
common-shake: bailed out: `module.exports` assignment in node_modules/process-nextick-args/index.js:20:3onExportDelete(filename, exportName)Handler called for every exported identifier that is being removed.
filename is the path to the file that exports the identifier. exportName is the name of the identifier. Return false to bail and keep the identifier.
onModuleBailout(module, reasons)Handler called when a module cannot be tree-shaked for some reason.
module is the Module object from common-shake.
reasons is an array of reasons that caused this module to be deoptimised.
onGlobalBailout(reasons)Handler called when tree-shaking is skipped entirely, usually because there is a dynamic require call in the source.
reasons is an array of reasons for skipping tree-shaking.
ecmaVersionParse with this ecmaVersion as interpreted by acorn. (default: 10)
gkatsev
me@gkatsev.com
maxogden
max@maxogden.com
thlorenz
thlorenz10@gmail.com
terinjokes
terinjokes@gmail.com
jmm
npm-public@jessemccarthy.net
mellowmelon
palmermebane@gmail.com
ashaffer88
darawk@gmail.com
balupton
b@lupton.cc
cwmma
calvin.metcalf@gmail.com
jprichardson
jprichardson@gmail.com
indutny
blackhole@livebox.sh
jryans
jryans@gmail.com
sethvincent
sethvincent@gmail.com
yoshuawuyts
javascript@yosh.is
ungoldman
ungoldman@gmail.com
ahdinosaur
michael.williams@enspiral.com
elnounch
contact@elnounch.net
parshap
parshap+npm@gmail.com
yerkopalma
yerko.palma@usach.cl
forbeslindesay
forbes@lindesay.co.uk
leichtgewicht
martin.heidegger@gmail.com
garann
garann@gmail.com
bret
bcomnes@gmail.com
anandthakker
vestibule@anandthakker.net
mattdesl
dave.des@gmail.com
hughsk
hughskennedy@gmail.com
fpereira1
pereira.filype@gmail.com
goto-bus-stop
renee@kooi.me
bpostlethwaite
post.ben.here@gmail.com
emilbayes
github@tixz.dk
stevemao
maochenyan@gmail.com
pkrumins
peteris.krumins@gmail.com
tehshrike
me@JoshDuff.com
defunctzombie
shtylman@gmail.com
lukechilds
lukechilds123@gmail.com
raynos
raynos2@gmail.com
Estimated unpacked size across 31 packages.
2.1 MB
Includes dependencies.
5 direct · 2 outdated
^2.0.3
5.0.12
^1.0.1
1.0.1
^2.4.3
2.4.4
^1.5.1
2.0.0
2.4.1