# asset-compare-git-webpack-plugin

> A webpack plugin that compares the generated asset sizes against those of a base branch as part of a CI build

Latest version **1.1.2** (published 2021-06-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install asset-compare-git-webpack-plugin
pnpm add asset-compare-git-webpack-plugin
yarn add asset-compare-git-webpack-plugin
bun add asset-compare-git-webpack-plugin
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2021-06-03 |
| First published | 2019-04-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 13.7 KB |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Supriya S |
| Maintainers | supriya-raj |

## Links

- npm: https://www.npmjs.com/package/asset-compare-git-webpack-plugin
- Repository: https://github.com/supriya-raj/asset-compare-git-webpack-plugin
- Issues: https://github.com/supriya-raj/asset-compare-git-webpack-plugin/issues
- npm.io page: https://npm.io/package/asset-compare-git-webpack-plugin

## Dependencies (4)

- [lodash](https://npm.io/package/lodash.md) 4.17.11
- [cli-table2](https://npm.io/package/cli-table2.md) 0.2.0
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) 18.5.3
- [markdown-table](https://npm.io/package/markdown-table.md) 1.1.2

## Recent versions

- 1.1.2 (latest) — 2021-06-03
- 1.1.1 — 2021-05-31
- 1.1.0 — 2021-05-31
- 1.0.5 — 2019-04-29
- 1.0.4 — 2019-04-13
- 1.0.3 — 2019-04-13
- 1.0.2 — 2019-04-13
- 1.0.1 — 2019-04-13
- 1.0.0 — 2019-04-05

## README

# Asset Compare Git Webpack Plugin

A zero configuration webpack plugin that compares the generated asset sizes of any given pull request/branch against those of master as part of a CI build.

> NOTE: Currently Travis and Github actions are the only CI environments supported

## Install

```bash
npm install --save-dev asset-compare-git-webpack-plugin
```

## Usage

In your `webpack.config.js`

```javascript
var AssetComparePlugin = require('asset-compare-git-webpack-plugin');

module.exports = {
    // ...
    plugins: [
      new AssetComparePlugin()
    ]
};
```
- The plugin automatically detects which CI environment it is running in(via default environment variables that the CI sets) and logs a table in the CI console comparing the asset sizes of the current build against those of master.
- It also creates a status check againt the last commit(of the pr/branch) which triggered the build. The check is a failure if any of the asset sizes has increased by more than 5% and a success otherwise.
- The asset sizes of master are obtained from a json file(`webpack-asset-sizes.json`) that this plugin maintains on the master branch of your repo.
- When a pr containing this plugin integration is merged into your master branch for the first time, it creates this json file.
- Every consequent pull request merge/push into master branch will keep updating this json file.

### Note

The only thing required for this plugin to work is a personal access token from github.
The plugin expects to find this in the `GITHUB_PERSONAL_TOKEN` environment variable
>The access token must have permissions to read/write from/into the repo.

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