gulp-sizereport

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

Install

1$ npm install --save-dev gulp-sizereport

Usage

A simple usage

1var gulp = require('gulp');
2var sizereport = require('gulp-sizereport');
3
4gulp.task('sizereport', function () {
5	return gulp.src('./dist/*')
6		.pipe(sizereport());
7});

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.

1var gulp = require('gulp');
2var sizereport = require('gulp-sizereport');
3
4gulp.task('sizereport', function () {
5    return gulp.src('./dist/*')
6        .pipe(sizereport({
7            gzip: true
8        }));
9});

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

1var gulp = require('gulp');
2var sizereport = require('gulp-sizereport');
3var UglifyJS = require('uglify-js');
4
5gulp.task('sizereport', function () {
6    return gulp.src('./src/**/*.js')
7        .pipe(sizereport({
8            minifier: function (contents, filepath) {
9                if (filepath.match(/\.min\./g)) {
10                    return contents
11                }
12                return UglifyJS.minify(contents, { fromString: true }).code;
13            }
14        }));
15});

Ideal to control the project size on the fly.

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

Alerts

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

• maxSize
• maxGzippedSize
• maxMinifiedSize
• maxMinifiedGzippedSize
• maxTotalSize
• maxTotalGzippedSize
• maxTotalMinifiedSize
• maxTotalMinifiedGzippedSize

1var gulp = require('gulp');
2var sizereport = require('gulp-sizereport');
3var UglifyJS = require('uglify-js');
4
5gulp.task('sizereport', function () {
6    return gulp.src('./dist/*.js')
7        .pipe(sizereport({
8            gzip: true,
9            minifier: function (contents) {
10                return UglifyJS.minify(contents, { fromString: true }).code;
11            },
12            '*': {
13                'maxSize': 100000
14            },
15            'pin.js': {
16                'maxMinifiedSize': 5500,
17                'maxMinifiedGzippedSize': 2500
18            }
19        }));
20});