lytics / confl Goto Github PK

encoding/json and friends have an API in the style of

func Marshal(val interface{}) ([]byte, error)
func Unmarshal(data []byte, v interface{}) error

func NewEncoder(w io.Writer) *Encoder
func (enc *Encoder) Encode(v interface{}) error

func NewDecoder(r io.Reader) *Decoder
func (dec *Decoder) Decode(v interface{}) error

Where "decode" means streaming operations and "marshal" operates on []byte.

Why not follow that? Right now, the confl API seems unlike good Go, and especially Decode taking a string comes off as very weird.

Apart from that, looks good. I've been wanting something like this for a while, and while https://github.com/hashicorp/hcl also looked promising, it seems confl integrates with the Go style of unmarshaling into a struct better.

Because map types cannot have the same key，is It possible to solve this conf?

Perhaps this would make sense. I can see a lot of callers wanting this; I did.

Inspiration:

• https://github.com/MakeNowJust/heredoc
• https://github.com/renstrom/dedent

Be careful to preserve inner indentation. That is:

foo (
    # I am an embedded markdown article

    Blah blah.

        func code() {
            // code inside markdown is indented more
        }

)

Note that the # there is not a comment, it's inside the string literal (this is already current confl behavior).

location ~* .(otf|eot|woff|ttf|woff2)$ {
types {font/opentype otf;}
types {application/vnd.ms-fontobject eot;}
types {font/truetype ttf;}
types {application/font-woff woff;}
types {font/woff2 woff2;}
}

location / {
try_files $uri $uri/ /index.html =404;
expires off;
add_header Cache-Control "no-cache, no-store, must-revalidate";
add_header Strict-Transport-Security "max-age=86400" always;
}

Just like nginx's configuration, how do i deal it ?

confl is machine editable and human readable which makes it an extremely useful tool. However, using a machine to edit a confl config results in the comments being lost.

$ cd $GOPATH/src/github.com/lytics/confl/_examples
$ go run example.go | tail -3
    multi line text with a block paren
    block ends with end paren on new line
)

This is even more obvious if you temporarily change the code to

    fmt.Printf("Description: %q\n", config.Description)

Courtesy of https://github.com/dvyukov/go-fuzz

I'll submit a pull request to include this in the tree next..

package main

import (
    "fmt"

    "github.com/lytics/confl"
)

func main() {
    var v map[string]interface{}
    fmt.Println("about to hang")
    confl.Unmarshal([]byte("\x0e9\xbd\xbf\xefr"), &v)
    fmt.Println("never gets here")
}