grunt-include-replace 
Grunt task to include files and replace variables.
Allows for parameterised file includes:
hello.html
<!DOCTYPE html>
<h1>Hello World!</h1>
<p>@@include('/path/to/include/message.html', {"name": "Joe Bloggs"})</p>message.html
Hello @@name!Result:
<!DOCTYPE html>
<h1>Hello World!</h1>
<p>Hello Joe Bloggs!</p>Getting started
Install grunt-include-replace:
cd /path/to/your/project
npm install grunt-include-replace
Note: as of version 0.1.0 this plugin requires grunt 0.4. Install version 0.0.0-beta for grunt 0.3 support.
Then add this line to your project's Gruntfile.js:
grunt.loadNpmTasks('grunt-include-replace');Next, configure the task in your Gruntfile.js:
// Add this task to your grunt.initConfig call
includereplace: {
dist: {
options: {
// Global variables available in all files
globals: {
var1: 'one',
var2: 'two',
var3: 'three'
},
// Optional variable prefix & suffix, defaults as shown
prefix: '@@',
suffix: '',
//Optional - directory where includes will be resolved, default relative to including file
includesDir: 'global_includes/'
},
// Files to perform replacements and includes with
src: '*.html',
// Destination directory to copy files to
dest: 'dist/'
}
}...or in "list" format:
includereplace: {
dist: {
options: {
globals: {foo: 'bar'}
},
files: {
'dist/js': 'js/**/*.js',
'dist/css': 'css/*.css'
}
}
}Run the task by invoking grunt includereplace
WARNING: The task does not check for recursive includes.
Release History
- 2013-04-26 v0.3.0 Added new option includesDir - if set all includes resolved relative to that directory
- 2013-04-19 v0.2.0 Added option processIncludeContents - a function that allows you to alter included file contents
- 2013-02-18 v0.1.0 Grunt 0.4.x support