Grunt replacer - replace code in files
JavaScript HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tasks
test
.gitignore
.jshintrc
.travis.yml
Gruntfile.js
LICENSE-MIT
README.md
package.json

README.md

grunt-replacer

NPM

Build Status devdependencies

Grunt replacer - replace string in files

Getting Started

This plugin requires Grunt >=0.4.5

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

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

grunt.loadNpmTasks('grunt-replacer');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade

Replacer Task

Run this task with the grunt replacer command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Options

variables

Type: replace

This option is used to define code which has to be replaced by other one.

options : {
    replace: {
        '<!-- to-replace -->'  : 'was replaced',
        'something to replace' : 'was replaced on this',
        '<!-- build-version -->: 'ver 0.1.0'
    }
}

Type: reportError

This option is used to trow error to grunt log. Default is "false"

options : {
    reportError: true
}

Usage Examples

Replace string in file

replacer: {
    index: {
        options : {
            replace: {
                '<!-- to-replace -->' : 'was replaced'
            }
        },
        files : [
            {src: ['path/to/file'], dest: 'path/to/output.file'}
        ]
    }
}

Replace string in file using function response

function(content) { return 'text'; } // @param string - content of replacing file
replacer: {
    index: {
        options : {
            replace: {
                '<!-- to-replace -->' : function(content) {
                    return 'was replaced';
                }
            }
        },
        files : [
            {src: ['path/to/file'], dest: 'path/to/output.file'}
        ]
    }
}

Release History

  • 2016-09-11 v0.4.4 Updated dependencies
  • 2016-02-27 v0.4.3 Updated dependencies
  • 2015-07-11 v0.4.2 Updated dev dependencies
  • 2015-07-03 v0.4.1 Clean up, fixed code formatting
  • 2013-10-20 v0.4.0 New features: colors, reportError and function as "to" param
  • 2013-07-19 v0.1.0 First version of replacer. Replace string in selected files

Task submitted by Tomasz Czechowski

This file was generated on Fri July 19 2013 12:40:00.