jwcc

type Array ¶

type Array struct {
	Values []Value
	// contains filtered or unexported fields
}

An Array is a commented array of values.

func (a *Array) Comments() *Comments

func (a Array) JSON() string

func (a Array) Len() int

func (a Array) String() string

func (a *Array) Undecorate() ast.Value

type Comments ¶

type Comments struct {
	Before []string
	Line   string
	End    []string
	// contains filtered or unexported fields
}

Comments records the comments associated with a value. All values have a comment record; use IsEmpty to test whether the value has any actual comment text.

Comments read during parsing are stored as-seen in the input, including comment markers. When adding or editing a comment programmatically, comment markers are optional; the text will be decorated when formatting the output. To include blank space separating multiple chunks of comment text, include an empty string. To include a blank line in the middle of a chunk, include a comment marker.

For example:

c := jtree.Comments{Before: []string{"a", "", "b"}}

renders as:

// a

// b

By contrast:

c := jtree.Comments{Before: []string{"a", "//", "c"}}

renders as:

// a
//
// b

If a comment begins with "//", it will be processed as line comments. If a comment begins with "/*" it will be processed as a block comment. Multiple lines are OK; they will be reformatted as necessary.

func (c *Comments) Clear()

func (c Comments) IsEmpty() bool

type Datum ¶

type Datum struct {
	ast.Value
	// contains filtered or unexported fields
}

A Datum is a commented base value; a string, number, Boolean, or null.

func (d *Datum) Comments() *Comments

func (d *Datum) Undecorate() ast.Value

type Document ¶

type Document struct {
	Value
	// contains filtered or unexported fields
}

A Document is a single value with optional trailing comments.

func Parse(r io.Reader) (*Document, error)

func (d *Document) Comments() *Comments

func (d *Document) Undecorate() ast.Value

type Formatter ¶

type Formatter struct{}

A Formatter carries the settings for pretty-printing JWCC values. A zero value is ready for use with default settings.

func (f Formatter) Format(w io.Writer, v Value) error

type Member ¶

type Member struct {
	Key   ast.Text
	Value Value
	// contains filtered or unexported fields
}

A Member is a key-value pair in an object.

func Field(key string, value any) *Member

func (m *Member) Comments() *Comments

func (m Member) JSON() string

func (m Member) String() string

func (m *Member) Undecorate() ast.Value

type Object ¶

type Object struct {
	Members []*Member
	// contains filtered or unexported fields
}

An Object is a collection of key-value members.

func (o *Object) Comments() *Comments

func (o *Object) Find(key string) *Member

func (o *Object) FindKey(f func(ast.Text) bool) *Member

func (o *Object) IndexKey(f func(ast.Text) bool) int

func (o Object) JSON() string

func (o Object) Len() int

func (o Object) Sort()

func (o Object) String() string

func (o *Object) Undecorate() ast.Value

type Value ¶

type Value interface {
	ast.Value

	// Comments returns the comments annotating this value.
	Comments() *Comments

	// Convert this value to an undecorated ast.Value.
	Undecorate() ast.Value
}

A Value is a JSON value optionally decorated with comments. The concrete type is one *Array, *Datum, *Document, or *Object.

func Decorate(v ast.Value) Value

func ToValue(v any) Value