grunt-replace-json

grunt-replace-json

Updates attributes of json 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-replace-json --save-dev

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

grunt.loadNpmTasks('grunt-replace-json');

The "replace_json" task

Overview

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

grunt.initConfig({
  replace_json: {
    your_target: {
      // Target-specific src and changes go here.
    },
  },
});

Options

src

The path of the file where the changes will be applied.

changes

A JSON object of the changes to be applied. Each key is the attribute name for a single property or attribute0.attribute1.(...).attributeN for nested attributes. If the attribute isn't present in the file, it will be added.

Usage Example

In this example we change the version of the dotenv dependency and add a new one in our package.json.

grunt.initConfig({
  replace_json: {
    dotenv:{
        src: 'dist/package.json',
        changes: {
            'dependencies.dotenv': '^2.0.0',
            'dependencies.grunt': '^0.4.2'
        }
    },
  },
});

Initial file:

{
    "dependencies": {
        "dotenv": "^1.0.0",
    }
}

Result file:

{
    "dependencies": {
        "dotenv": "^2.0.0",
        "grunt": "^0.4.2"
    }
}