Installations
npm install merge-jsons-webpack-pluginReleases
Custom glob options fix
Published on 04 Apr 2020
Pretty print and preserve duplicates.
Published on 28 Sept 2019
Support for "prefixFileName" function
Published on 28 Apr 2019
BOM characters handling
Published on 21 Sept 2018
File Extn Check Removed
Published on 27 Jul 2018
Webpack 4 Deprecated Api fixes
Published on 16 Jun 2018
Developer
Developer Guide
Module System
CommonJS
Min. Node Version
Typescript Support
No
Node Version
14.17.5
NPM Version
6.14.14
Statistics
36 Stars
80 Commits
20 Forks
5 Watching
25 Branches
4 Contributors
Updated on 09 Oct 2024
Languages
JavaScript (51.64%)
TypeScript (47.29%)
HTML (1.08%)
Total Downloads
Cumulative downloads
Total Downloads
9,157,614
Last day
-19.1%
9,955
Compared to previous day
Last week
-35.4%
74,376
Compared to previous week
Last month
256.1%
530,463
Compared to previous month
Last year
42%
2,029,083
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
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.
Latest version and breaking changes.
-
Breaking changes introduced in latest version 2.0.0, now all values will be overwritten including arrays, earlier behaviour was to concatenate array and overrite literals.Going foward to concatenate either literals or arrays, pass overwrite false as an input, this will concatenate all values in target with source values.
-
This version also fixes compatibility issue with Webpack 5
Usage
Install with npm
npm i merge-jsons-webpack-plugin
1var MergeJsonWebpackPlugin = require("merge-jsons-webpack-plugin"); 2new MergeJsonWebpackPlugin({ 3 files: ["./jsons/file1.json", "./jsons/file3.json", "./jsons/file2.json"], 4 output: { 5 fileName: "./dist/result.json", 6 }, 7});
Details
You can specify either files or groupBy under output.
1) By files
If you want to merge group of files use like this.
1new MergeJsonWebpackPlugin({ 2 debug: true, 3 files: ["./jsons/file1.json", "./jsons/file3.json", "./jsons/file2.json"], 4 output: { 5 fileName: "./dist/result.json", 6 }, 7});
| Field Name | Description |
|---|---|
| files | Array of json files to be merged |
| output.fileName | Name of merged output file ,relative path from output.path entry |
2) 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.
1new MergeJsonWebpackPlugin({ 2 encoding: "ascii", 3 debug: true, 4 output: { 5 groupBy: [ 6 { 7 pattern: "{./jsons/module*/en.json,./jsons/file1.json}", 8 fileName: "./dist/en.json", 9 }, 10 { 11 pattern: "{./jsons/module*/es.json,./jsons/file2.json}", 12 fileName: "./dist/es.json", 13 }, 14 ], 15 }, 16 globOptions: { 17 nosort: true, 18 }, 19});
| 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 |
3) Run time files
Files generated at run time can also be specified as input to the pattern.The plugin will lookup in the compilation.assets of webpack and try to load it for processing.
Options
| key | Description. | |
|---|---|---|
| debug | if true, logs will be enabled, by default debug is false. | |
| encoding | Optional, encoding to be used default is utf-8. | |
| globOptions | Optional, glob options to change pattern matching behavior. | |
| prefixFileName | Optional. If true, file names will be prefixed to each file content and merged with outfile By default, the generated prefix is ​​simply the filename without the .json extension. If you want to customize the process of generating prefixes, you can pass a function as this option. The function should take exactly one argument (the file path) and returns the prefix. | |
| space | Optional. A String or Number object that's used to insert white space into the output JSON file for readability purposes. See space parameter description on MDN for details. | |
| overwrite | Default true, if false values(for same keys) at same heirarchy will be preserved in an array. Check example, issue #31, issue #63 . |
Change Logs
| Version | Changes |
|---|---|
| 1.0.8 | Error handling improved. Now fileName is relative path to output path specified |
| 1.0.10 | File watching feature added, result will be automatically refreshed if json files are modified |
| 1.0.11 | Publish issues with previous version |
| 1.0.12 | Added glob options handling |
| 1.0.13 | When using groupBy,fixed issue of compilation more than once, added capability to read dynamically generated files,and conditional logging |
| 1.0.14 | Webpack 4 breaking changes fix |
| 1.0.15 | prefixFileName option added, for feature request #31 |
| 1.0.16 | Webpack 4 compatibile api changes |
| 1.0.17 | Filex extension check removed,file can be of any extention as long as content is json.Testcases also added |
| 1.0.18 | Bom issue fix #22 |
| 1.0.19 | Support for custom "prefixFileName" function |
| 1.0.20 | Output formatting via space parameter added, preserving duplicates in an array if duplicates:true instead of overriding existing value. |
| 2.0.0-alpha | Breaking Changes Webpack 5 compatibility update, removed duplicates option, instead added overwrite with default value true, this will break existing behaviour of concatination in case of an array, instead now by default overwrites array value in target object. |
| 2.0.0 | Json processing moved to compilation hook additionalAssets and changed to sync to fix issue #68 |
Sample
To see sample you can navigate to example folder. From the root folder merge-jsons-webpack-plugin, you can start the sample application as mentioned below
> npm install
> npm start
Access the web application at
http://localhost:8080
References
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE.txt:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE.txt:0
Reason
Found 2/21 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 14 are checked with a SAST tool
Reason
65 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
- Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
- Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
- Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-86wf-436m-h424
- Warn: Project is vulnerable to: GHSA-8w57-jfpm-945m
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-8g7p-74h8-hg48
- Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
- Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
- Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
- Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
- Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
- Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-29xr-v42j-r956
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
- Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
- Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
- Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
- Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
- Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
- Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
1.7
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More