package jsonkit_test

import (

"bytes"

"errors"

"fmt"

"strings"

jsonkit "github.com/forgemechanic/jsonkit"

"github.com/forgemechanic/jsonkit/exp/source"

)

func ExampleParse() {

src := source.NewBytes("example.jsonc", []byte("// note\n{\"id\": 42}\n"))

res := jsonkit.Parse(

src,

jsonkit.WithProfile(jsonkit.ProfileJSONC),

jsonkit.WithRetentionMode(jsonkit.RetentionValidateOnly),

)

fmt.Println(res.OK())

fmt.Println(res.Mode() == jsonkit.RetentionValidateOnly)

// Output:

// true

// true

}

func ExampleParse_embeddedBlock() {

host := []byte("before {name:'jsonkit'} after")

start := int64(strings.Index(string(host), "{"))

end := int64(strings.LastIndex(string(host), "}") + 1)

src := source.NewBytes("host.txt", host)

res := jsonkit.Parse(

src,

jsonkit.WithProfile(jsonkit.ProfileJSON5),

jsonkit.WithEmbeddedBlock(jsonkit.EmbeddedBlock{

Start: start,

End: end,

UseHostOffsets: true,

}),

)

meta, ok := res.Embedded()

fmt.Println(res.OK())

fmt.Println(ok)

fmt.Println(meta.EffectiveStart == start && meta.EffectiveEnd == end)

// Output:

// true

// true

// true

}

func ExampleParse_tokensMode() {

src := source.NewBytes("tokens.json", []byte(`{"id":1}`))

res := jsonkit.Parse(src, jsonkit.WithRetentionMode(jsonkit.RetentionTokens))

_, cstOK := res.CST()

tokens, tokOK := res.TokenStream()

fmt.Println(cstOK)

fmt.Println(tokOK && len(tokens) > 0)

// Output:

// false

// true

}

func ExampleUnmarshal() {

var dst struct {

Name string `json:"name"`

}

err := jsonkit.Unmarshal([]byte(`{"name":"jsonkit"}`), &dst)

fmt.Println(dst.Name)

fmt.Println(err == nil)

// Output:

// jsonkit

// true

}

func ExampleUnmarshalWithOptions() {

var dst struct {

Name string `json:"name"`

}

res, err := jsonkit.UnmarshalWithOptions(

[]byte(`{name:'jsonkit'}`),

&dst,

jsonkit.WithDecodeProfile(jsonkit.ProfileJSON5),

)

fmt.Println(dst.Name)

fmt.Println(err == nil)

fmt.Println(res.Profile() == jsonkit.ProfileJSON5)

// Output:

// jsonkit

// true

// true

}

func ExampleUnmarshalWithOptions_useNumber() {

var dst map[string]any

_, err := jsonkit.UnmarshalWithOptions(

[]byte(`{"n":1}`),

&dst,

jsonkit.WithDecodeUseNumber(),

)

fmt.Println(err == nil)

fmt.Printf("%T\n", dst["n"])

// Output:

// true

// json.Number

}

func ExampleUnmarshalWithOptions_disallowUnknownFields() {

type payload struct {

Name string `json:"name"`

}

var dst payload

_, err := jsonkit.UnmarshalWithOptions(

[]byte(`{"name":"jsonkit","extra":1}`),

&dst,

jsonkit.WithDecodeDisallowUnknownFields(),

)

fmt.Println(err != nil)

// Output:

// true

}

func ExampleUnmarshalWithOptions_diagnostics() {

var dst map[string]any

_, err := jsonkit.UnmarshalWithOptions(

[]byte(`{"name": }`),

&dst,

jsonkit.WithDecodeDiagnostics(true),

)

var derr *jsonkit.DecodeError

fmt.Println(err != nil)

fmt.Println(errors.As(err, &derr))

fmt.Println(len(derr.Diagnostics()) > 0)

// Output:

// true

// true

// true

}

func ExampleNewDecoderWithOptions() {

dec := jsonkit.NewDecoderWithOptions(

strings.NewReader(`{name:'jsonkit'}`),

jsonkit.WithDecodeProfile(jsonkit.ProfileJSON5),

)

var dst struct {

Name string `json:"name"`

}

err := dec.Decode(&dst)

fmt.Println(err == nil)

fmt.Println(dst.Name)

// Output:

// true

// jsonkit

}

func ExampleValid() {

fmt.Println(jsonkit.Valid([]byte(`{"ok":true}`)))

fmt.Println(jsonkit.Valid([]byte(`{ok:true}`)))

// Output:

// true

// false

}

func ExampleMarshalWithOptions() {

type payload struct {

Message string `json:"message"`

OK bool `json:"ok"`

}

out, err := jsonkit.MarshalWithOptions(

payload{Message: "hello", OK: true},

jsonkit.WithEncodeProfile(jsonkit.ProfileJSON5),

jsonkit.WithEncodeUnquotedKeys(true),

jsonkit.WithEncodeStringQuoteStyle(jsonkit.EncodeQuoteSingle),

jsonkit.WithEncodeTrailingCommas(true),

)

fmt.Println(err == nil)

fmt.Println(string(out))

// Output:

// true

// {message:'hello',ok:true,}

}

func ExampleMarshal() {

out, err := jsonkit.Marshal(struct {

ID int `json:"id"`

}{ID: 7})

fmt.Println(err == nil)

fmt.Println(string(out))

// Output:

// true

// {"id":7}

}

func ExampleMarshalIndent() {

out, err := jsonkit.MarshalIndent(struct {

ID int `json:"id"`

Name string `json:"name"`

}{ID: 7, Name: "jsonkit"}, "", " ")

fmt.Println(err == nil)

fmt.Println(string(out))

// Output:

// true

// {

// "id": 7,

// "name": "jsonkit"

// }

}

func ExampleMarshalWithOptions_leadingComment() {

out, err := jsonkit.MarshalWithOptions(

struct {

ID int `json:"id"`

}{ID: 1},

jsonkit.WithEncodeProfile(jsonkit.ProfileJSON5),

jsonkit.WithEncodeLeadingComment("generated", jsonkit.EncodeCommentLine),

jsonkit.WithEncodeUnquotedKeys(true),

)

fmt.Println(err == nil)

fmt.Println(string(out))

// Output:

// true

// // generated

// {id:1}

}

func ExampleNewEncoderWithOptions() {

var buf bytes.Buffer

enc := jsonkit.NewEncoderWithOptions(

&buf,

jsonkit.WithEncodeProfile(jsonkit.ProfileJSON5),

jsonkit.WithEncodeUnquotedKeys(true),

jsonkit.WithEncodeTrailingCommas(true),

)

err := enc.Encode(struct {

ID int `json:"id"`

}{ID: 2})

fmt.Println(err == nil)

fmt.Printf("%q\n", buf.String())

// Output:

// true

// "{id:2,}\n"

}