grunt-json-merge
Grunt plugin to merge JSON files handling override of keys
Getting Started
This plugin requires Grunt >=0.4
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-json-merge --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "json_merge" task
Overview
In your project's Gruntfile, add a section named json_merge
to the data object passed into grunt.initConfig()
.
grunt;
Options
options.replacer
Type: Function
or Array
Default value: null
Replacer option for JSON.stringify as specified in documentation
options.space
Type: String
Default value: \t
Spacer string for JSON.stringify as specified in documentation
Usage Examples
General
Json files will be merged and colliding keys will be overwrite from latest to first file defined in src parameter. So in this case:
grunt;
Properties in file b
will overwrite properties in file a
.
For further information read documentation of underscoreDeepExtend which is internally used to merge properties
Default Options
Merge all files .json
in a direcotry to create a merged file specified as destination
grunt;
Custom Options
Merge all files .json
in a direcotry to create a merged file specified as destination. In this case we use custom spaces which are four spaes as you can see in options
grunt;
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.2.2
- Readme improvements 0.2.0
- Powerful merge 0.1.0
- Base functionalities