tree-shake

Tree-shake

Inspired by agadoo lib

Is your project 100% tree-shakeable?

With treeshake, you can find out which files and code lines that are not tree-shakeable.

Usage

Simply run npx treeshake in your project root. Make sure you have your entry point defined in package.json under either "module" or "main".

Upon running, you'll get notification whether your code is 100% tree-shakeable or not. If not, it will tell which file(s) are causing/ affected by side-effects and the codes that caused it.

********** reading files **********

     tree88shakey
  TREESHAKEtRe eSha
 kETREESHaKetreeshAKE
TreeShakEY o0o tREeSHAKE
    Es6  /T r eesHakeY
      \///  /Thanks
        \//////
         |||||
         |||||
         |||||
   .....//||||\....
Awesome! Your code is 100% tree-shakeable!

or

********** reading files **********
Unshaken files:

/path/to/your/file.js

/another/path/to/your/file.js

********** reading codes **********
Unshaken codes:
console.log("Side-effects");

********** Finished Reading **********

How do I make my project tree-shakeable?

• Use ES6's import and export
• As much as possible, not have side-effects

More resources on JS modules

• Dead code elimination vs tree shaking
• Anatomy of JS module systems
• JS module system
• RollupJS
• ESM
• ESM usage
• ESM cartoon
• Why you should use ESM
• Does node run all code inside required modules?

Please feel free to ask any question/ submit PR!