grunt-sync-json

Keep various json files in sync (e.g. package.json and bower.json)

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-sync-json --save-dev

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

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

The "sync-json" task

If you need to keep config values in sync across various json files, this task is for you. Configure at only one place (e.g. package.json) and copy the relevant values to another (e.g. bower.json).

Overview

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

grunt.initConfig({
  "sync-json": {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Please note, that sync-json cannot handle multiple input files. I would have like it to handle multiple output files (such as keep bower.json and manifest.json in sync with package.json), but that is not the way Grunt handles files. So you have to configure one task for each file.

Options

options.indent

Type: Number Default: 2

options.newline

Type: Boolean Default: true

If set to true, the output file will end with a new line.

options.include

Type: Array<String>

An array of properties to copy from the source file to the destination file. You can also use a different property name for the destination file using property_in_src as property_in_dest.

Usage Examples

In this example, we copy the name, description, version and author from package.json to bower.json.

grunt.initConfig({
  "sync-json": {
    "options": {
      "indent": 4,
      "include": [
        "name",
        "description",
        "version",
        "author as authors" // is "author" in package.json, but "authors" in bower.json
      ]
    },
    "bower": {
      files: {
        "bower.json": "package.json"
      }
    }
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

• 0.4.0 Add option to end destination file with a new line
• 0.3.0 Rename task to grunt-sync-json
• 0.2.0 Rename properties to include
• 0.1.0 Initial release