gulp-check-filesize

    2.0.1 • Public • Published

    gulp-check-filesize

    check-filesize plugin for gulp

    This plugin logs the size of a given file. If you set a filesize limit, it logs a warning if the limit is exceeded.

    Usage

    First, install gulp-check-filesize as a development dependency:

    npm install --save-dev gulp-check-filesize

    Then, add it to your gulpfile.js:

    var checkFilesize = require("gulp-check-filesize");
     
    gulp.src("css/**/*.css")
        .pipe(checkFilesize()
        .pipe(gulp.dest("./dist"));

    This produces a log that will look something like this:

    $ gulp css
    [19:30:55] Using gulpfile /var/www/project/gulpfile.js
    [19:30:57] Starting 'css'...
    [19:30:57] Size of main.css : 16.4 kB
    [19:30:57] Finished 'css' after 502 ms
     

    enable gzip

    You can enable the gzip option to also check the filesize after gzip compression.

    var checkFilesize = require("gulp-check-filesize");
     
    gulp.src("css/**/*.css")
        .pipe(checkFilesize({
            enableGzip: true
        })
        .pipe(gulp.dest("./dist"));

    This produces a log that will look something like this:

    $ gulp css
    [19:30:55] Using gulpfile /var/www/project/gulpfile.js
    [19:30:57] Starting 'css'...
    [19:30:57] Size of main.css: 114.32 kB (19.47 kB gzipped)
    [19:30:57] Finished 'css' after 502 ms
     

    Setting filesize limit

    You can specify a maximum filesize (in Byte). If the filesize is exceeded, the plugin will log a warning (see also fileSizeLimitGzipped):

    var checkFilesize = require("gulp-check-filesize");
     
    gulp.src("css/**/*.css")
        .pipe(checkFilesize({
            fileSizeLimit: 16384 // 16384 === 16kb
        })
        .pipe(gulp.dest("./dist"));
    $ gulp css
    [19:30:55] Using gulpfile /var/www/project/gulpfile.js
    [19:30:57] Starting 'css'...
    [19:30:57] WARNING: cloudBackup.css exceeded filesize limit of 16 kB: 16.4 kB
    [19:30:57] Finished 'css' after 502 ms

    API

    checkFilesize(options)

    You can pass an optional options object to the plugin.

    options.enableGzip

    Type: Boolean
    Default: false

    Output gzipped filesize as well

    options.filesizeLimit

    Type: Number
    Default: undefined

    Your filesize limit in Bytes

    options.filesizeLimitGzipped

    Type: Number
    Default: undefined

    Your filesize limit for gzipped files in Bytes

    License

    MIT License

    Install

    npm i gulp-check-filesize

    DownloadsWeekly Downloads

    2,682

    Version

    2.0.1

    License

    MIT

    Last publish

    Collaborators

    • kaesetoast