grunt-dev-prod-switch


> Use to switch between previously defined comment blocks in project files to change environment from development to production and back.

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:

``shell
npm install grunt-dev-prod-switch --save-dev
`

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

`js
grunt.loadNpmTasks('grunt-dev-prod-switch');
`

The "dev_prod_switch" task

$3


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

`js
grunt.initConfig({

...

dev_prod_switch: {
options: {
environment: 'dev',
env_char: '#',
env_block_dev: 'env:dev',
env_block_prod: 'env:prod'
},
all: {
files: {
'app/index.html': 'app/index.html',
'app/js/main.js': 'app/js/main.js'
}
}
}

...

});
`

Or

`js
grunt.initConfig({

...

dev_prod_switch: {
options: {
// Can be ran as grunt --env=dev or grunt --env=prod
environment: grunt.option('env') || 'dev', // 'prod' or 'dev'
env_char: '#',
env_block_dev: 'env:dev',
env_block_prod: 'env:prod'
},
dynamic_mappings: {
files: [{
expand: true,
cwd: './',
src: ['*.html'],
dest: './'
}]
}
}

...

});
`

In _html_ or _ColdFusion_ type of files place the code depending on environment as follows:

`
...




For devs eyes only

This will be visable in 'dev' environment

For everyone

This will be visable in 'prod' environment

...

`

In _C_, _Java_, _JavaScript_ type of files place the code depending on environment as follows:

`
...

/ env:dev /
function add(a,b) {
console.log('ADD: ' + a + ' + ' + b + ' = ' + (a + b));
return a+b;
}
/ env:dev:end /


/ env:prod /
function add(a,b) {
return a+b;
}
/ env:prod:end /

...

`

$3

`js

// Options to switch environment (dev/prod)
var env_option = {
env_dev: 'env:dev',
env_prod: 'env:prod',
blocking_char: '#'
};

/**
* dev
*
* Change environment to "development"
* Use: gulp dev
*/
gulp.task('dev', function() {
var files = [
'./app/index.html'
];
files.forEach(function(file) {
var content = fs.readFileSync(file, "utf8")
.replace(new RegExp("<\!-- " + env_option.env_dev + " --" + env_option.blocking_char + ">","gi"), '')
.replace(new RegExp("<\!-- " + env_option.env_prod + " -->","gi"), '')
.replace(new RegExp("<\!-- " + env_option.env_dev + " -->","gi"), ' comment blocks

#### options.env_block_prod _(optional)_
Type: String
Default value: 'env:prod'

Override the default string of the comment.
So the task will be searching for ` comment blocks