grunt-bake

grunt-bake

Bake external includes into the file to create static pages with no compilation time

Getting Started

This plugin requires Grunt ~0.4.0

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-bake --save-dev

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

grunt.loadNpmTasks( "grunt-bake" );

The "bake" task

Overview

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

grunt.initConfig( {
	bake: {
		your_target: {
			options: {
				// Task-specific options go here.
			},

			files: {
				// files to parse
			}
		},
	},
} )

Options

options.content

Type: String Default value: null

A string value that is determines the location of the JSON file used to parse the includes with.

options.verbose

Type: Boolean Default value: false

A string value that determines weather the grunt-bake should give extra console output. This can be used to track and debug which files have been created.

options.section

Type: String Default value: ""

A string that determines which subsection of the JSON passed as content should be used. If no section is passed the entire JSON will be used for templating.

Given a content JSON like such:

{
	"en": {
		"title": "Book"
	},

	"de": {
		"title": "Buch"
	}
}

If "en" is passed as section, only { "title": "Book" } will be passed to the include. If no section is specified the entire JSON will be passed.

options.process

Type: Function Default value: null

A Function which is used to process the template before putting it into the file. If no process given or null given the default process is used. The function gets passed to arguments:

• template: String: representing the template to parse.
• content: Object: the section of the content file.

Usage Examples

Default Options

This example shows a simple baking process with all default options.

grunt.initConfig( {
	bake: {
		build: {
			files: {
				"app/index.html": "app/base.html"
			}
		}
	}
} )

Advanced bake

This example shows how to use the bake process to parse the templates with a provided JSON and a section.

grunt.initConfig( {
	bake: {
		build: {
			options: {
				content: "app/content.json",
				section: "en"
			}

			files: {
				"app/index.html": "app/base.html"
			}
		}
	}
} )

As an example for the content.json:

{
	"en": {
		"title": "Hello World"
	},

	"de": {
		"title": "Hallo Welt"
	}
}

Costum process

This example shows the use of a costum process funtion.

var processFunction( source, content ) {
	return ...
}

grunt.initConfig( {
	bake: {
		build: {
			options: {
				content: "app/content.json",
				section: "en",
				process: processFunction
			}

			files: {
				"app/index.html": "app/base.html"
			}
		}
	}
} )

Release History

(Nothing yet)