example_test.go

package hclencoder

import (
	"log"

	"fmt"
)

func Example() {
	type Farm struct {
		Name     string    `hcl:"name"`
		Owned    bool      `hcl:"owned"`
		Location []float64 `hcl:"location"`
	}

	type Farmer struct {
		Name                 string `hcl:"name"`
		Age                  int    `hcl:"age"`
		SocialSecurityNumber string `hcle:"omit"`
	}

	type Animal struct {
		Name  string `hcl:",key"`
		Sound string `hcl:"says" hcle:"omitempty"`
	}

	type Pet struct {
		Species string `hcl:",key"`
		Name    string `hcl:",key"`
		Sound   string `hcl:"says" hcle:"omitempty"`
	}

	type Config struct {
		Farm      `hcl:",squash"`
		Farmer    Farmer            `hcl:"farmer"`
		Animals   []Animal          `hcl:"animal"`
		Pets      []Pet             `hcl:"pet"`
		Buildings map[string]string `hcl:"buildings"`
	}

	input := Config{
		Farm: Farm{
			Name:     "Ol' McDonald's Farm",
			Owned:    true,
			Location: []float64{12.34, -5.67},
		},
		Farmer: Farmer{
			Name:                 "Robert Beauregard-Michele McDonald, III",
			Age:                  65,
			SocialSecurityNumber: "please-dont-share-me",
		},
		Animals: []Animal{
			{
				Name:  "cow",
				Sound: "moo",
			},
			{
				Name:  "pig",
				Sound: "oink",
			},
			{
				Name: "rock",
			},
		},
		Pets: []Pet{
			{
				Species: "cat",
				Name:    "whiskers",
				Sound:   "meow",
			},
		},
		Buildings: map[string]string{
			"House": "123 Numbers Lane",
			"Barn":  "456 Digits Drive",
		},
	}

	hcl, err := Encode(input)
	if err != nil {
		log.Fatal("unable to encode: ", err)
	}

	fmt.Print(string(hcl))

	// Output:
	// name = "Ol' McDonald's Farm"
	//
	// owned = true
	//
	// location = [
	//   12.34,
	//   -5.67,
	// ]
	//
	// farmer {
	//   name = "Robert Beauregard-Michele McDonald, III"
	//   age  = 65
	// }
	//
	// animal "cow" {
	//   says = "moo"
	// }
	//
	// animal "pig" {
	//   says = "oink"
	// }
	//
	// animal "rock" {}
	//
	// pet "cat" "whiskers" {
	//   says = "meow"
	// }
	//
	// buildings {
	//   Barn  = "456 Digits Drive"
	//   House = "123 Numbers Lane"
	// }
	//
}