merge-jsons-webpack-plugin

Merge json files

Merge Json files using this webpack plugin.

For example,it will be useful to merge i18n json files which are in different modules into a single final json files in angular2 or react modules.

Usage

Install with npm

npm i merge-jsons-webpack-plugin

 var MergeJsonWebpackPlugin = require("merge-jsons-webpack-plugin")
 new MergeJsonWebpackPlugin({
            "files": ['./jsons/file1.json',
                './jsons/file3.json',
                './jsons/file2.json'],
            "output":{
                "fileName":"./dist/result.json"
            }
        })

Details

You can specify either files or groupBy under output.

1. By files

   If you want to merge group of files use like this.

           new MergeJsonWebpackPlugin({                                           
                                        "files": ['./jsons/file1.json',  
                                                  './jsons/file3.json',                                                
                                                  './jsons/file2.json'],
                                        "output":{
                                             "fileName":"./dist/result.json"                         
                                       }
                             })
                        
   

Field Name	Description
files	Array of json files to be merged
output.fileName	Name of merged output file ,relative path from output.path entry
encoding	Optional,encoding to be used default is utf-8

1. By Patterns

   This plugin uses glob for searching file patterns,please refer glob for usage for sample pattern.
   You can specify a pattern to pull all the files that satify the particular pattern and output a single json file.

   new MergeJsonWebpackPlugin({
               "encoding":"ascii",
               "output":{
                 "groupBy":[
                               { "pattern":"{./jsons/module*/en.json,./jsons/file1.json}", 
                                  "fileName":"./dist/en.json" 
                               },
                               { "pattern":"{./jsons/module*/es.json,./jsons/file2.json}", 
                                   "fileName":"./dist/es.json" }
                           ]        
                       }
              })  
   

groupBy	Array of patterns and corresponding fileNames.
groupBy[].pattern	Pattern to search files for. eg: **/en.json will pull all en.json files under current working directory and sub directories
	Do not use curly brackets if there is only single pattern to consider	pattern:"./node_modules/**/en.json"
	Use curly brackets to group more than one pattern together	pattern:"{./node_modules/**/en.json,./src/assets/i18n/en.json}"
groupBy[].fileName	output file name for the corresponding pattern.Relative path from output.path entry
encoding	Optional,encoding to be used default is utf-8

Change Logs

Version	Changes
1.0.8	Error handling improved. Now fileName is relative path to output path specified

Sample

Please navigate to example folder

   cd example
   > npm install
   > npm start

Access the web application at

 http://localhost:8080

##References

• https://www.npmjs.com/package/glob