tree-shake

1.0.5 • Public • Published

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?

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

More resources on JS modules


Please feel free to ask any question/ submit PR!

/tree-shake/

    Package Sidebar

    Install

    npm i tree-shake

    Weekly Downloads

    5

    Version

    1.0.5

    License

    mit

    Unpacked Size

    5.45 kB

    Total Files

    4

    Last publish

    Collaborators

    • iggredible