JSONMergerLib 1.0.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package JSONMergerLib --version 1.0.0
                    


                    

                
NuGet\Install-Package JSONMergerLib -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="JSONMergerLib" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="JSONMergerLib" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="JSONMergerLib" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add JSONMergerLib --version 1.0.0
                    


                    

                
#r "nuget: JSONMergerLib, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package JSONMergerLib@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=JSONMergerLib&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=JSONMergerLib&version=1.0.0
                    


                            Install as a Cake Tool

JSONMerger

Introduction

A JSON merging utility that merges multiple JSON files into one.

Made it mainly for myself for future projects, so don't expect clean code or tons of features, but feel free to use it if you feel like this could be of use to you.

Behaviour

When pointing it to a folder, the utility has two different possible behaviors :

  • Array mode : If the folder doesn't have a folderMappping.json, it reads all JSON files from the folder and its subfolder (and expects them to be arrays), merges them all together and returns an array with all the merged results.
  • Object mode : If the folder has a folderMapping.json, then it reads it (and expects it to be a single object with string properties, keys being arbitrary names and values being folder paths), then for each property, it will create a property in the result object, its key being the folder mapping property's key and the value being the value of the recursive call of the JSONMerger on the folder defined in the value of the folder. "Loose" elements (those not in any mapped folder) will be added to the result object under the content key. Trying to define manually a folder mapping with the content key will throw an exception.

The first call to the JSONMapper will always operate in object mode. If there is no folderMapping.json, then all elements will be added to content. Therefore, the resulting JSON will always be an object which can have multiple arrays as property values.

To illustrate the intended behaviour, example inputs with the expected output are available in the JSONTestResources folder.

Usage

This project is mainly meant to be used as a library in other projects. However, we provide a very simple CLI interface for quick testing in the JSONMergerCLI C# project.

It is meant to be used like this

JSONMergerCLI.exe <input_path> <output_path>

You need to manually specify the output file name at the end of the output path. Also note that there is absolutely zero validation on the arguments you provide to the CLI tool.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 193 9/2/2024