gulp-size

Display the size of your project

Logs out the total size of files in the stream and optionally the individual file-sizes.

Install

$ npm install --save-dev gulp-size

Usage

const gulp = require('gulp');
const size = require('gulp-size');
 
gulp.task('default', () =>
    gulp.src('fixture.js')
        .pipe(size())
        .pipe(gulp.dest('dist'))
);

API

size([options])

options

title

Type: string
Default: ''

Give it a title so it's possible to distinguish the output of multiple instances logging at once.

gzip

Type: boolean
Default: false

Displays the gzipped size instead.

pretty

Type: boolean
Default: true

Displays prettified size: 1337 B → 1.34 kB.

showFiles

Type: boolean
Default: false

Displays the size of every file instead of just the total size.

showTotal

Type: boolean
Default: true

Displays the total of all files.

size.size

Type: number
Example: 12423000

The total size of all files in bytes.

size.prettySize

Type: string
Example: '14 kB'

Prettified version of .size.

Useful for eg. reporting the total project size with gulp-notify:

const gulp = require('gulp');
const size = require('gulp-size');
const notify = require('gulp-notify');
 
gulp.task('default', () => {
    const s = size();
 
    return gulp.src('fixture.js')
        .pipe(s)
        .pipe(gulp.dest('dist'))
        .pipe(notify({
            onLast: true,
            message: () => `Total size ${s.prettySize}`
        }));
});

gulp-size

gulp-size

Install

Usage

API

size([options])

options

title

gzip

pretty

showFiles

showTotal

size.size

size.prettySize

License

We ♥ your boss

Collaborators list

Stats

Try it out

Keywords

Dependencies (7)

Dependents (195)