# gulp-sizereport

> Display the size and gzipped size of your project, trigger alarm when file size is higher as expected

Latest version **1.2.1** (published 2018-10-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-sizereport
pnpm add gulp-sizereport
yarn add gulp-sizereport
bun add gulp-sizereport
```

## 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.2.1 |
| Published | 2018-10-01 |
| First published | 2014-11-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 7 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 39 |
| Author | Jay Salvat |
| Maintainers | jaysalvat |
| Keywords | gulpplugin, report, filesize, file, size, log, measure, inspect, debug, gzip |

## Links

- npm: https://www.npmjs.com/package/gulp-sizereport
- Repository: https://github.com/jaysalvat/gulp-sizereport
- Homepage: https://github.com/jaysalvat/gulp-sizereport#readme
- Issues: https://github.com/jaysalvat/gulp-sizereport/issues
- npm.io page: https://npm.io/package/gulp-sizereport

## Dependencies (7)

- [beeper](https://npm.io/package/beeper.md) ^1.1.1
- [through2](https://npm.io/package/through2.md) ^2.0.1
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.1
- [gzip-size](https://npm.io/package/gzip-size.md) ^3.0.0
- [ansi-colors](https://npm.io/package/ansi-colors.md) ^1.0.1
- [plugin-error](https://npm.io/package/plugin-error.md) ^1.0.0
- [pretty-bytes](https://npm.io/package/pretty-bytes.md) ^3.0.1

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.2.1 (latest) — 2018-10-01
- 1.2.0 — 2016-08-22
- 1.1.3 — 2015-07-30
- 1.1.2 — 2015-05-13
- 1.0.2 — 2015-01-13
- 1.0.1 — 2014-11-20
- 1.0.0 — 2014-11-19

## README

# gulp-sizereport

[![npm version](https://badge.fury.io/js/gulp-sizereport.svg)](http://badge.fury.io/js/gulp-sizereport)

Display a report of the size and Gzipped size of your project and trigger alarms when the sizes are higher than expected.

![Screenshot](https://raw.githubusercontent.com/jaysalvat/gulp-sizereport/master/screenshot0.png)

## Install

```sh
$ npm install --save-dev gulp-sizereport
```

## Usage

A simple usage

```js
var gulp = require('gulp');
var sizereport = require('gulp-sizereport');

gulp.task('sizereport', function () {
	return gulp.src('./dist/*')
		.pipe(sizereport());
});
```

![Screenshot](https://raw.githubusercontent.com/jaysalvat/gulp-sizereport/master/screenshot1.png)

## Options

- ``title`` (default: null)
Display a title above the table.

- ``total`` (default: true)
Display the last total row.

- ``gzip`` (default: false)
Toggle the Gzipped size column.

- ``fail`` (default: false)
Allows you to fail your Gulp task if a file exceeds a threshold.

```js
var gulp = require('gulp');
var sizereport = require('gulp-sizereport');

gulp.task('sizereport', function () {
    return gulp.src('./dist/*')
        .pipe(sizereport({
            gzip: true
        }));
});
```

![Screenshot](https://raw.githubusercontent.com/jaysalvat/gulp-sizereport/master/screenshot2.png)

- ``minifier`` (default: null)
You can add a minifier in order to control the minified size of your source.

```js
var gulp = require('gulp');
var sizereport = require('gulp-sizereport');
var UglifyJS = require('uglify-js');

gulp.task('sizereport', function () {
    return gulp.src('./src/**/*.js')
        .pipe(sizereport({
            minifier: function (contents, filepath) {
                if (filepath.match(/\.min\./g)) {
                    return contents
                }
                return UglifyJS.minify(contents, { fromString: true }).code;
            }
        }));
});
```

![Screenshot](https://raw.githubusercontent.com/jaysalvat/gulp-sizereport/master/screenshot3.png)

Ideal to control the project size on the fly.

```js
gulp.task('watch', function () {
    gulp.watch('./src/**/*.js', [ 'sizereport'] );
});
```

## Alerts

You can place some alerts on values and files. The value is in Bytes.

- ``maxSize``
- ``maxGzippedSize``
- ``maxMinifiedSize``
- ``maxMinifiedGzippedSize``
- ``maxTotalSize``
- ``maxTotalGzippedSize``
- ``maxTotalMinifiedSize``
- ``maxTotalMinifiedGzippedSize``

```js
var gulp = require('gulp');
var sizereport = require('gulp-sizereport');
var UglifyJS = require('uglify-js');

gulp.task('sizereport', function () {
    return gulp.src('./dist/*.js')
        .pipe(sizereport({
            gzip: true,
            minifier: function (contents) {
                return UglifyJS.minify(contents, { fromString: true }).code;
            },
            '*': {
                'maxSize': 100000
            },
            'pin.js': {
                'maxMinifiedSize': 5500,
                'maxMinifiedGzippedSize': 2500
            }
        }));
});
```

![Screenshot](https://raw.githubusercontent.com/jaysalvat/gulp-sizereport/master/screenshot4.png)

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