format

package

v0.0.20 Latest Latest Go to latest Published: Dec 20, 2025 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/signadot/tony-format

Links

Open Source Insights

Documentation ¶

Overview ¶

Package format provides formatting utilities for Tony documents.

Usage ¶

// Format a Tony document
formatted, err := format.Format(input)

// Format with specific options
formatted, err := format.Format(input, format.WithIndent(2))

Formatting preserves semantic content while applying consistent style.

Related Packages ¶

github.com/signadot/tony-format/go-tony/parse - Parse text to IR
github.com/signadot/tony-format/go-tony/encode - Encode IR to text

Index ¶

Variables
type Format
- func ParseFormat(v string) (Format, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrBadFormat = errors.New("bad format")

Functions ¶

This section is empty.

Types ¶

type Format ¶

type Format int

const (
	TonyFormat Format = iota
	YAMLFormat
	JSONFormat
)

func ParseFormat ¶

func ParseFormat(v string) (Format, error)

func (Format) IsJSON ¶

func (f Format) IsJSON() bool

func (Format) IsTony ¶

func (f Format) IsTony() bool

func (Format) IsYAML ¶

func (f Format) IsYAML() bool

func (Format) MarshalText ¶

func (f Format) MarshalText() ([]byte, error)

func (Format) String ¶

func (f Format) String() string

func (*Format) UnmarshalText ¶

func (f *Format) UnmarshalText(d []byte) error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL