# webpack-distsize

> Track Webpack output size via version control

Latest version **1.0.0** (published 2021-01-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install webpack-distsize
pnpm add webpack-distsize
yarn add webpack-distsize
bun add webpack-distsize
```

Provides the command `distsize`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-01-31 |
| First published | 2020-06-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 13.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Hiroki Osame |
| Maintainers | hirokiosame |
| Keywords | webpack, distsize, distribution, size |

## Links

- npm: https://www.npmjs.com/package/webpack-distsize
- Repository: https://github.com/privatenumber/webpack-distsize
- Homepage: https://github.com/privatenumber/webpack-distsize#readme
- Issues: https://github.com/privatenumber/webpack-distsize/issues
- Funding: https://github.com/privatenumber/webpack-distsize?sponsor=1
- npm.io page: https://npm.io/package/webpack-distsize

## Dependencies (7)

- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [byte-size](https://npm.io/package/byte-size.md) ^7.0.0
- [gzip-size](https://npm.io/package/gzip-size.md) ^6.0.0
- [cli-simple-table](https://npm.io/package/cli-simple-table.md) 1.0.1
- [@pvtnbr/eslint-config-base](https://npm.io/package/@pvtnbr/eslint-config-base.md) ^0.1.9

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2021-01-31
- 0.1.0 — 2020-06-23
- 0.0.2 — 2020-06-11
- 0.0.1 — 2020-06-11

## README

# Webpack Distsize <a href="https://npm.im/webpack-distsize"><img src="https://badgen.net/npm/v/webpack-distsize"></a> <a href="https://npm.im/webpack-distsize"><img src="https://badgen.net/npm/dm/webpack-distsize"></a> <a href="https://packagephobia.now.sh/result?p=webpack-distsize"><img src="https://packagephobia.now.sh/badge?p=webpack-distsize"></a>

<p align="center">
  <img src="https://github.com/privatenumber/webpack-distsize/raw/master/.github/screenshot.png" width="70%">
  <br>
  <i>Track Webpack output size via version control</i>
  <br><br>
  <sub>If you like this project, please star it & <a href="https://github.com/privatenumber">follow me</a> to see what other cool projects I'm working on! ❤️</sub>

</p>

## ⭐️ Features
- **📊 Size conscious** Be aware of how your changes impact file size
- **💅 Pretty formatting** View color-coded assets ordered by size via `npx distsize`
- **⚙️ Configurable** Save distsize data where you like and set custom thresholds


## 🚀 Install
```sh
npm i -D webpack-distsize
```


## 👩‍🏫 Easy setup

Add to your Webpack config:
```js
// 1. Import plugin
const Distsize = require('webpack-distsize');

module.exports = {
	...,

	plugins: [
		// 2. Add to plugins array
		new Distsize()
	]
};
```

Run your Webpack build and track the produced `.distsize.json` file via version control.

### Distsize viewing

The plugin installs the `distsize` binary to view the outputted distsize JSON file. IT defaults to reading `.distsize.json` in the current directory, but pass in a path to read from a custom path.

```sh
npx distsize
```


## 🎛 Options 
Configure Distisze by passing in an options object:
```js
new Distsize({
	// Options
})
```

- `log` `<Boolean>` (default `true`)  - Whether to log the distsize to stdout

- `filepath` `<String>` (default `.distsize.json`) - Output location for distsize JSON data

- `indent` `<Number|String>`  (default `2`) - Indentation for distsize JSON data

- `filter` `<Function(assetName)|RegExp|String>` (`null`)  - Filter to include assets by name
  ```js
  // Example filter that ignores hidden files and source-maps
  filter: (asset) => !asset.startsWith('.') && !asset.endsWith('.map')
  ```

- `thresholds` `<Array>` - Color coding to use for size thresholds

  ```json5
  [
    { threshold: 100000, color: 'red' },
    { threshold: 50000, color: 'orange' },
    { threshold: 10000, color: 'yellow' },
    { threshold: 5000, color: 'dodgerblue' },
    { threshold: 0, color: 'lime' },
  ]
  ```

  
## 💁‍♀️ FAQ
- **Can it track and display asset growth?**

  Depends on your Webpack configuration. If your assets are emitted under the same name, then yes.

  But if it usses [`[hash]`, `[contenthash]`, `[chunkhash]`](https://webpack.js.org/configuration/output/#template-strings), then it's not possible to _accurately_ draw a comparison across builds.

- **Can it track size impact from dependency changes?**

  If a dependency change impacts distribution size, it will be reflected by this plugin, but it will not contain any details that hint at which dependency grew in size. I recommend doing upgrades in isolation so it's easily identifiable. 

  Distsize focuses specifically on distribution size and making it digestible because that alone can be overwhelming—a large codebase can produce hundreds of assets.

  If you want something similar for dependencies, I recommend using [webpack-dependency-size](https://github.com/privatenumber/webpack-dependency-size).


## 👨‍👩‍👧 Related
- [webpack-dependency-size](https://github.com/privatenumber/webpack-dependency-size) - Analyze dependency assets bundled into your Webpack build

- [webpack-analyze-duplication-plugin](https://github.com/privatenumber/webpack-analyze-duplication-plugin) - Detect duplicated modules in your Webpack build

## 💼 License

MIT

---
_Source: https://npm.io/package/webpack-distsize · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._