Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A grunt-task that base64 encodes files.
JavaScript
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
tasks
test
.gitignore
.jshintrc
Gruntfile.js
LICENSE.md
README.md
package.json

README.md

grunt-base64

A grunt task to base 64 encode files.

There are a number of good grunt plugins that do slightly more interesting things with base64 encoding like replace image URLs in your stylesheets with data URIs (grunt-image-embed, for instance). This task just wraps node.js's native base64 encoding capabilities into a grunt task; it's up to you to find something interesting to do with the output.

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-base64 --save-dev

One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-base64');

The "base64" task

Overview

In your project's Gruntfile, add a section named base64 to the data object passed into grunt.initConfig().

grunt.initConfig({
  base64: {
    your_target: {
      // Target-specific file lists and/or options go here.
      files: {
        'output.b64': 'input.binary'
      }
    },
  },
})

Options

The base64 task does not take any options beyond which specifying source and destination files.

Usage Examples

The base64 task takes a standard files configuration and transforms input files into base64-encoded outputs. It can optionally concatenate multiple inputs together:

grunt.initConfig({
  base64: {
    files: {
      'dest/testing123.b64': ['src/testing', 'src/123'],
    },
  },
})

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

0.1.0: Initial release

Something went wrong with that request. Please try again.