npm 中文文档

package-size


preview

How does this work?


Install the packages with yarn or npm in a temp directory
Bundle the packages with webpack and get the bundle size
Show you the bundle size and cache it by package version

Install


  1. ``` shell
  2. yarn global add package-size
  3. ```

Usage


The package is bundled with Webpack.

  1. ``` shell
  2. # get the size of vue bundle
  3. package-size vue

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

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

  11. # get the size of react+react-dom without using the cache
  12. package-size react,react-dom --no-cache

  14. # get the size of file in current working directory
  15. package-size ./dist/index.js
  16. # or a package in current working directory, explictly using `--cwd` flag
  17. package-size vue --cwd

  19. # or event multiple versions for the same package!
  20. package-size react@0.10 react@0.14 react@15

  22. # save results to file system in JSON format
  23. # defaults to ./package-size-output.json
  24. package-size cherow --output
  25. # or custom path
  26. package-size cherow --output stats.json

  28. # analyze bundle with webpack-bundle-analyzer
  29. package-size cherow --analyze
  30. # analyze bundle with webpack-bundle-analyzer on a different port
  31. package-size cherow --analyze --port 9000
  32. ```

API


  1. ``` js
  2. const getSizes = require('package-size')

  4. getSizes('react,react-dom', options)
  5.   .then(data => {
  6.     console.log(data)
  7.     //=>
  8.     {
  9.       name: 'react,react-dom',
  10.       size: 12023, // in bytes
  11.       minified: 2342,
  12.       gzipped: 534,
  13.       versionedName: 'react@16.0.0,react-dom@16.0.0'
  14.     }
  15.   })
  16. ```

options


sort


Type: boolean Default: false

Sort packages in size (from small to large).

cwd


Type: boolean Default: false

Resolve modules in current working directory instead of a cache folder. Relative path will set cwd to true by default.

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 :

  1. ``` shell
  2. package-size styled-jsx/style --externals react
  3. ```

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$/

cache


Type: boolean Default: true

If cache is set to false, then package-size will not use cached build sizes. To use this from the CLI, pass --no-cache as an argument.

target


Type: string Default: browser Values: browser node

Build target. In node target, all node_modules will be excluded and output format is set to CommonJS.

registry


Type: string Default: undefined

npm registry to install the package from. By default it uses the default npm registry.

resolve


Type: string string[] Default: undefined

Extra folders to resolve local node_modules from.

Contributing


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

Author


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

egoist.moe · GitHub @egoist · Twitter @_egoistlily