Help us shape the future of Go! Take the 2026 Go Developer Survey

config

package
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 15, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrDiffFound = errors.New("DiffFound")
View Source 
var ErrNoDiffCommand = errors.New("NoDiffCommand")

Functions

func HelpMarkdown added in v0.13.1 

func HelpMarkdown() string

HelpMarkdown returns the markdown help string.

func Usage added in v0.13.1 

func Usage() string

Usage returns the CLI usage string.

Types

type Config 

type Config struct {
	Context              int       `name:"context" short:"C" default:"3" usage:"diff context"`
	Separator            string    `name:"separator" short:"d" default:">" usage:"object id separator"`
	Indent               int       `name:"indent" short:"n" default:"2" usage:"yaml indent"`
	Out                  string    `name:"out" short:"o" default:"text" usage:"output format: text,yaml,id,idlist,markdown"`
	Debug                bool      `name:"debug" usage:"enable debug log"`
	Quiet                bool      `name:"quiet" short:"q" usage:"quiet log"`
	Color                bool      `name:"color" short:"c" usage:"colored diff"`
	DiffSuccess          bool      `name:"success" usage:"exit with 0 even if inputs differ"`
	AllowDuplicateKey    bool      `name:"allow-duplicate-key" default:"true" usage:"allow the use of keys with the same name in the same map"`
	DiffCommand          string    `name:"diff-cmd" short:"x" usage:"invoke this to get diff instead of builtin differ"`
	Verbose              bool      `name:"verbose" short:"v" usage:"enable verbose output; annotate diff type and display summary"`
	Labels               []string  `` /* 136-byte string literal not displayed */
	MarkdownHeadingLevel uint      `name:"markdown-heading" default:"1" usage:"highest heading level in markdown"`
	Stdin                io.Reader `name:"-"`
	IgnoreMatchingLines  []string  `` /* 150-byte string literal not displayed */
	IgnoreFields         []string  `` /* 150-byte string literal not displayed */
	IgnoreLabels         []string  `` /* 132-byte string literal not displayed */
	IgnoreAnnotations    []string  `` /* 142-byte string literal not displayed */
	IgnoreManagedFields  bool      `name:"ignore-managed-fields" short:"m" usage:"ignore metadata.managedFields"`
	IgnoreStatus         bool      `name:"ignore-status" short:"s" usage:"ignore status field"`
}

func (*Config) OutMode 

func (c *Config) OutMode() OutMode

func (*Config) Run 

func (c *Config) Run(w io.Writer, left, right string) error

type Help added in v0.13.1 

type Help struct{}

Help represents the help documentation structure for objdiff.

func NewHelp added in v0.13.1 

func NewHelp() *Help

func (*Help) ConfigurationContent added in v0.13.1 

func (h *Help) ConfigurationContent() string

func (*Help) ConfigurationHeading added in v0.13.1 

func (h *Help) ConfigurationHeading() string

func (*Help) ConfigurationSection added in v0.13.1 

func (h *Help) ConfigurationSection() string

func (*Help) ExitStatusContent added in v0.13.1 

func (h *Help) ExitStatusContent() string

func (*Help) ExitStatusHeading added in v0.13.1 

func (h *Help) ExitStatusHeading() string

func (*Help) ExitStatusSection added in v0.13.1 

func (h *Help) ExitStatusSection() string

func (*Help) FlagsHeading added in v0.13.1 

func (h *Help) FlagsHeading() string

func (*Help) HelpMarkdown added in v0.13.1 

func (h *Help) HelpMarkdown() string

HelpMarkdown generates the markdown representation of help without flag contents.

func (*Help) ObjectIDContent added in v0.13.1 

func (h *Help) ObjectIDContent() string

func (*Help) ObjectIDHeading added in v0.13.1 

func (h *Help) ObjectIDHeading() string

func (*Help) ObjectIDSection added in v0.13.1 

func (h *Help) ObjectIDSection() string

func (*Help) OutputFormatContent added in v0.13.1 

func (h *Help) OutputFormatContent() string

func (*Help) OutputFormatHeading added in v0.13.1 

func (h *Help) OutputFormatHeading() string

func (*Help) OutputFormatSection added in v0.13.1 

func (h *Help) OutputFormatSection() string

func (*Help) OverrideDifferContent added in v0.13.1 

func (h *Help) OverrideDifferContent() string

func (*Help) OverrideDifferHeading added in v0.13.1 

func (h *Help) OverrideDifferHeading() string

func (*Help) OverrideDifferSection added in v0.13.1 

func (h *Help) OverrideDifferSection() string

func (*Help) Title added in v0.13.1 

func (h *Help) Title() string

func (*Help) Usage added in v0.13.1 

func (h *Help) Usage() string

Usage generates the usage text used in CLI help (excluding dynamic flag options).

func (*Help) UsageContent added in v0.13.1 

func (h *Help) UsageContent() string

func (*Help) UsageHeading added in v0.13.1 

func (h *Help) UsageHeading() string

func (*Help) UsageSection added in v0.13.1 

func (h *Help) UsageSection() string

type MarkdownDoc added in v0.13.1 

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

MarkdownDoc represents a markdown document builder.

func NewMarkdownDoc added in v0.13.1 

func NewMarkdownDoc() *MarkdownDoc

func (*MarkdownDoc) AddCodeBlock added in v0.13.1 

func (d *MarkdownDoc) AddCodeBlock(lang, code string) *MarkdownDoc

func (*MarkdownDoc) AddHeading added in v0.13.1 

func (d *MarkdownDoc) AddHeading(level int, title string) *MarkdownDoc

func (*MarkdownDoc) AddParagraph added in v0.13.1 

func (d *MarkdownDoc) AddParagraph(text string) *MarkdownDoc

func (*MarkdownDoc) AddRaw added in v0.13.1 

func (d *MarkdownDoc) AddRaw(content string) *MarkdownDoc

func (*MarkdownDoc) String added in v0.13.1 

func (d *MarkdownDoc) String() string

type OutMode 

type OutMode string
const (
	OutModeUnknown  OutMode = "unknown"
	OutModeText     OutMode = "text"
	OutModeYaml     OutMode = "yaml"
	OutModeID       OutMode = "id"
	OutModeIDList   OutMode = "idlist"
	OutModeMarkdown OutMode = "markdown"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.