Mergo: merging Go structs and maps since 2013.
Clone or download
imdario Merge pull request #87 from gwenaelp/master
Update README.md : Hall of Fame integration
Latest commit ca3dcc1 Nov 7, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
testdata Fixing YAML test Oct 9, 2017
.gitignore Updated README and improved .gitignore Jan 12, 2018
.travis.yml Fixing .travis.yml Apr 2, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jun 20, 2017
LICENSE Mergo is alive! Mar 11, 2013
README.md Merge pull request #87 from gwenaelp/master Nov 7, 2018
doc.go Recursive map merge done. Mar 19, 2013
issue17_test.go Issue #33 explained and #52 refactored Jan 12, 2018
issue23_test.go Fixing pull request #62 Apr 1, 2018
issue33_test.go Fixed typo Jan 12, 2018
issue38_test.go go fmt Oct 9, 2017
issue50_test.go fix & go fmt Dec 2, 2017
issue52_test.go Issue #33 explained and #52 refactored Jan 12, 2018
issue61_test.go Revised test for #61 Apr 2, 2018
issue64_test.go Override slices if WithOverride is specified Mar 20, 2018
issue66_test.go Don't append slice if not asked to Jun 8, 2018
map.go Exporting Config and Transformers type (fixes #55) Apr 2, 2018
merge.go Appending slice can cause Mergo to panic… Jul 23, 2018
merge_appendslice_test.go Add an option to append slice Apr 3, 2018
merge_test.go Protect merge with transformer from nil/invalid values Jan 19, 2018
mergo.go Look through interfaces and pointers when determining emptiness May 22, 2018
mergo_test.go Appending slice can cause Mergo to panic… Jul 23, 2018
pr80_test.go Look through interfaces and pointers when determining emptiness May 22, 2018
pr81_test.go PR #81 merged May 22, 2018

README.md

Mergo

A helper to merge structs and maps in Golang. Useful for configuration default values, avoiding messy if-statements.

Also a lovely comune (municipality) in the Province of Ancona in the Italian region of Marche.

Status

It is ready for production use. It is used in several projects by Docker, Google, The Linux Foundation, VMWare, Shopify, etc.

GoDoc GoCard Build Status Coverage Status Sourcegraph FOSSA Status

Latest release

Release v0.3.6.

Important note

Please keep in mind that in 0.3.2 Mergo changed Merge()and Map() signatures to support transformers. An optional/variadic argument has been added, so it won't break existing code.

If you were using Mergo before April 6th 2015, please check your project works as intended after updating your local copy with go get -u github.com/imdario/mergo. I apologize for any issue caused by its previous behavior and any future bug that Mergo could cause (I hope it won't!) in existing projects after the change (release 0.2.0).

Donations

If Mergo is useful to you, consider buying me a coffee, a beer or making a monthly donation so I can keep building great free software. 😍

Buy Me a Coffee at ko-fi.com Beerpay Beerpay Donate using Liberapay

Mergo in the wild

Installation

go get github.com/imdario/mergo

// use in your .go code
import (
    "github.com/imdario/mergo"
)

Usage

You can only merge same-type structs with exported fields initialized as zero value of their type and same-types maps. Mergo won't merge unexported (private) fields but will do recursively any exported one. It won't merge empty structs value as they are not considered zero values either. Also maps will be merged recursively except for structs inside maps (because they are not addressable using Go reflection).

if err := mergo.Merge(&dst, src); err != nil {
    // ...
}

Also, you can merge overwriting values using the transformer WithOverride.

if err := mergo.Merge(&dst, src, mergo.WithOverride); err != nil {
    // ...
}

Additionally, you can map a map[string]interface{} to a struct (and otherwise, from struct to map), following the same restrictions as in Merge(). Keys are capitalized to find each corresponding exported field.

if err := mergo.Map(&dst, srcMap); err != nil {
    // ...
}

Warning: if you map a struct to map, it won't do it recursively. Don't expect Mergo to map struct members of your struct as map[string]interface{}. They will be just assigned as values.

More information and examples in godoc documentation.

Nice example

package main

import (
	"fmt"
	"github.com/imdario/mergo"
)

type Foo struct {
	A string
	B int64
}

func main() {
	src := Foo{
		A: "one",
		B: 2,
	}
	dest := Foo{
		A: "two",
	}
	mergo.Merge(&dest, src)
	fmt.Println(dest)
	// Will print
	// {two 2}
}

Note: if test are failing due missing package, please execute:

go get gopkg.in/yaml.v2

Transformers

Transformers allow to merge specific types differently than in the default behavior. In other words, now you can customize how some types are merged. For example, time.Time is a struct; it doesn't have zero value but IsZero can return true because it has fields with zero value. How can we merge a non-zero time.Time?

package main

import (
	"fmt"
	"github.com/imdario/mergo"
        "reflect"
        "time"
)

type timeTransfomer struct {
}

func (t timeTransfomer) Transformer(typ reflect.Type) func(dst, src reflect.Value) error {
	if typ == reflect.TypeOf(time.Time{}) {
		return func(dst, src reflect.Value) error {
			if dst.CanSet() {
				isZero := dst.MethodByName("IsZero")
				result := isZero.Call([]reflect.Value{})
				if result[0].Bool() {
					dst.Set(src)
				}
			}
			return nil
		}
	}
	return nil
}

type Snapshot struct {
	Time time.Time
	// ...
}

func main() {
	src := Snapshot{time.Now()}
	dest := Snapshot{}
	mergo.Merge(&dest, src, mergo.WithTransformers(timeTransfomer{}))
	fmt.Println(dest)
	// Will print
	// { 2018-01-12 01:15:00 +0000 UTC m=+0.000000001 }
}

Contact me

If I can help you, you have an idea or you are using Mergo in your projects, don't hesitate to drop me a line (or a pull request): @im_dario

About

Written by Dario Castañé.

Top Contributors

0 1 2 3 4 5 6 7

License

BSD 3-Clause license, as Go language.

FOSSA Status