jmerge

README

jmerge

Overview

jmerge can merge multiple json files.

Install

# jmerge
$ go get github.com/akubi0w1/jmerge

# jmerge-cli - go get
$ go get github.com/akubi0w1/jmerge/jmerge-cli

# jmerge-cli - brew
$ brew tap akubi0w1/tap
$ brew install akubi0w1/tap/jmerge-cli

Examples

jmerge

See example/merge for merge example.

package main

import (
	"fmt"

	"github.com/akubi0w1/jmerge"
	"github.com/akubi0w1/jmerge/helper"
)

func main() {
	// prepare base
	base, err := helper.ReadFile("./base.json")
	if err != nil {
		panic(err)
	}

	// prepare overlay
	overlay, err := helper.ReadFile("./overlay.json")
	if err != nil {
		panic(err)
	}

	// merge
	out, err := jmerge.MergeJSON(base, overlay, jmerge.MergeModeIgnore, true)
	if err != nil {
		panic(err)
	}

	fmt.Println(string(out))
}

// base:
{
  "host": "127.0.0.1",
  "port": "8080",
  "mysql": {
    "user": "root",
    "password": "password",
    "host": "127.0.0.1",
    "port": "3306",
    "database": "main"
  }
}

// overlay:
{
  "port": "80",
  "mysql": {
    "user": "worker",
    "password": "akubi"
  }
}

// result
{
  "host": "127.0.0.1",
  "mysql": {
    "database": "main",
    "host": "127.0.0.1",
    "password": "akubi",
    "port": "3306",
    "user": "worker"
  },
  "port": "80"
}

jmerge cli

See cli/example for merge example using cli.

File structure:

./
├── base
│   └── http
│       └── setting.json
├── output
│   └── dev
│       └── http
│           └── setting.json
└── overlay
    ├── dev
    │   ├── http
    │   │   └── setting.json
    │   └── jmerge.yaml
    └── prd
        ├── http
        │   └── setting.json
        └── jmerge.yaml

Config:

# config: jmerge.yaml

namespace: dev

# path of base file
base: ../../base

# output path for after merge
output: ../../output

# whether to format output
format: true

# merge target
merges:
  # mode is add or ignore
  - mode: add
    targets:
      - http/setting.json

Execute:

# execute cli
$ jmerge-cli merge

Usege:

merge multiple json files into one.

Usage:
  jmerge-cli merge [flags]

Flags:
  -c, --config string   config file path (default "jmerge.yaml")
  -h, --help            help for merge

Documentation

Index

• func MergeJSON(base, overlay []byte, mode MergeMode, isFormat bool) ([]byte, error)
• type MergeMode
  • func (m MergeMode) Validate() error

Functions

func MergeJSON

func MergeJSON(base, overlay []byte, mode MergeMode, isFormat bool) ([]byte, error)

MergeJSON merges multiple json. base and overlay is json bytes.

Types

type MergeMode

type MergeMode string

MergeMode is behavior of merge. add-mode add and merge values not in base. ignore-mode do not add values that are not in base.

const (
	// MergeModeAdd add values not in base.
	MergeModeAdd MergeMode = "add"

	// MergeMode do not add values that are not in base.
	MergeModeIgnore MergeMode = "ignore"
)

func (MergeMode) Validate

func (m MergeMode) Validate() error

Validate validates merge mode