Skip to content

Gulp task for converting all data found within a stylesheet (those within a url( ... ) declaration) into base64-encoded data URI strings

License

Notifications You must be signed in to change notification settings

MichaelJGW/gulp-base64

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gulp-base64 -> gulp-base64-updated

This is a Fork from https://github.com/Wenqer/gulp-base64 it was made and published to NPM from the lack of response to security audits from the repo. Once the security audits are resolved if ever this repo will be removed.

The new npm package is gulp-base64-updated

Gulp task for converting all files found within a stylesheet (those within a url( ... ) declaration) into base64-encoded data URI strings.

Install

Install with npm

npm install gulp-base64-updated --save-dev

Example usage

var gulp = require('gulp');
var base64 = require('./build/gulp-base64-updated');

//basic example
gulp.task('build', function () {
    return gulp.src('./css/*.css')
        .pipe(base64())
        .pipe(concat('main.css'))
        .pipe(gulp.dest('./public/css'));
});
...
//example with options
gulp.task('build', function () {
    return gulp.src('./css/*.css')
        .pipe(base64({
            baseDir: 'public',
            extensions: ['svg', 'png', /\.jpg#datauri$/i],
            exclude:    [/\.server\.(com|net)\/dynamic\//, '--live.jpg'],
            maxImageSize: 8*1024, // bytes,
            deleteAfterEncoding: false,
            debug: true
        }))
        .pipe(concat('main.css'))
        .pipe(gulp.dest('./public/css'));
});

Options

  • baseDir (String)
    If you have absolute image paths in your stylesheet, the path specified in this option will be used as the base directory (relative to gulpfile).

  • deleteAfterEncoding (Boolean)
    Set this to true to delete images after they've been encoded. You'll want to do this in a staging area, and not in your source directories. Be careful.

  • extensions (Array of String or RegExps)
    Proccess only specified extensions.
    Strings are matched against file-extension only, while RegExps are tested against the raw URL value.

  • exclude (Array of String or RegExps)
    Skip files with URLs that match these patterns.
    Unlike with the extensions option Strings are sub-string matched against the whole URL value.

  • maxImageSize (Number)
    Maximum filesize in bytes for changing image to base64.

  • debug (Boolean)
    Enable log to console.

About

Gulp task for converting all data found within a stylesheet (those within a url( ... ) declaration) into base64-encoded data URI strings

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%