jsonview

package

v1.18.1 Latest Latest Go to latest Published: Sep 24, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Details

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

Repository

github.com/openai/openai-cli

Links

Open Source Insights

Documentation ¶

Index ¶

func ExploreJSON(title string, json gjson.Result) error
func ExploreJSONStream[T any](title string, it Iterator[T]) error
func RenderJSON(title string, json gjson.Result) string
func SanitizeTerminalString(s string) string
func WriteTerminalText(dst io.Writer, src io.Reader) error
type AnyIterator
type Iterator
type JSONView
type JSONViewer
type TableView
type TextView

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ExploreJSON ¶

func ExploreJSON(title string, json gjson.Result) error

ExploreJSON explores a single JSON value known ahead of time

func ExploreJSONStream ¶

func ExploreJSONStream[T any](title string, it Iterator[T]) error

ExploreJSONStream explores JSON data loaded incrementally via an iterator

func RenderJSON ¶

func RenderJSON(title string, json gjson.Result) string

func SanitizeTerminalString ¶ added in v1.9.0

func SanitizeTerminalString(s string) string

SanitizeTerminalString escapes control characters that terminals can interpret.

func WriteTerminalText ¶ added in v1.18.1

func WriteTerminalText(dst io.Writer, src io.Reader) error

WriteTerminalText streams untrusted text with terminal controls escaped, keeping newlines and tabs for readable layout. Malformed UTF-8 becomes replacement characters, as in SanitizeTerminalString. It is only for terminal presentation; files, pipes, and explicitly requested raw output must retain their original bytes.

Types ¶

type AnyIterator ¶

type AnyIterator interface {
	Next() bool
	Err() error
	Current() any
}

An iterator over `any` values

type Iterator ¶

type Iterator[T any] interface {
	Next() bool
	Err() error
	Current() T
}

A generic iterator interface that is used by the `genericIterator` struct below to convert iterators over specific types to an AnyIterator

type JSONView ¶

type JSONView interface {
	GetPath() string
	GetData() gjson.Result
	Update(tea.Msg, bool) tea.Cmd
	View() string
	Resize(width, height int)
}

type JSONViewer ¶

type JSONViewer struct {
	// contains filtered or unexported fields
}

func (*JSONViewer) Init ¶

func (v *JSONViewer) Init() tea.Cmd

func (*JSONViewer) Update ¶

func (v *JSONViewer) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*JSONViewer) View ¶

func (v *JSONViewer) View() string

type TableView ¶

type TableView struct {
	// contains filtered or unexported fields
}

func (*TableView) GetData ¶

func (tv *TableView) GetData() gjson.Result

func (*TableView) GetPath ¶

func (tv *TableView) GetPath() string

func (*TableView) Resize ¶

func (tv *TableView) Resize(width, height int)

func (*TableView) Update ¶

func (tv *TableView) Update(msg tea.Msg, raw bool) tea.Cmd

func (*TableView) View ¶

func (tv *TableView) View() string

type TextView ¶

type TextView struct {
	// contains filtered or unexported fields
}

func (*TextView) GetData ¶

func (tv *TextView) GetData() gjson.Result

func (*TextView) GetPath ¶

func (tv *TextView) GetPath() string

func (*TextView) Resize ¶

func (tv *TextView) Resize(width, height int)

func (*TextView) Update ¶

func (tv *TextView) Update(msg tea.Msg, raw bool) tea.Cmd

func (*TextView) View ¶

func (tv *TextView) View() string

Source Files ¶

View all Source files

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