package-size

Install

yarn global add package-size

Usage

# get the size of vue bundle
package-size vue

# get the size of react+react-dom bundle
package-size react,react-dom

# get the size of vue react+react-dom preact bundles
package-size vue react,react-dom preact

# get the size of package in current working directory
# it should be already installed or `require-able` in cwd
package-size object-assign --cwd
package-size ./dist/index.js --cwd

If the package contains ES6 code, please use --es6 option, otherwise it will throw error.

How does it work

Packages will be cached at ~/.package-size-cache and we use yarn-install to install them, if Yarn is not available on your machine, it automatically fallbacks to npm install.

Something like package-size react@0.14 react@15 will not work correctly, since they're installed at the same time, it's supposed to be one version for one package at a time. (PR for fixing this is welcome)

API

const getSizes = require('package-size')

getSizes(['vue', 'react,react-dom', 'preact'], options)
  .then(data => {
    /*
    [
      ['vue', '{size}', '{minified size}', '{gzipped size}'],
      ['react,react-dom', '{size}', '{minified size}', '{gzipped size}'],
      ['preact', '{size}', '{minified size}', '{gzipped size}']
    ]
    */
  })

options

es6

Type: boolean
Default: false

Compile ES6 to ES5 using buble.

cwd

Type: boolean
Default: false

Resolve modules in current working directory instead of ~/.package-size-cache

externals

Type: string or Array<string|RegExp>
Default: undefined

The package to exclude from bundled file, for example, to get the bundle size of styled-jsx/style we need to exclude react:

package-size styled-jsx/style --externals react

Note that if some item in externals is provided as string, it will be wrapped in a regular expression. For example: react is treated as /^react$/

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Author

package-size © EGOIST, Released under the MIT License.
Authored and maintained by EGOIST with help from contributors (list).

egoistian.com · GitHub @egoist · Twitter @rem_rin_rin