cli

Documentation

Index

• Constants
• func Check(r *report.Report) bool
• func PrintFull(r *report.Report)
• func PrintStruct(r *report.Report, strName string, optimal bool)
• func Run(gitRev string, gomod []byte)
• type Renderer
  • func NewRenderer(fields []*report.Field, detailed bool) *Renderer
  • func (r *Renderer) PrintField(f *report.Field)
  • func (r *Renderer) PrintPlaceholder()

Constants

const (
	APP  = "aligo"
	VER  = "1.6.1"
	DESC = "Utility for viewing and checking Golang struct alignment"
)

App info

const (
	OPT_ARCH     = "a:arch"
	OPT_STRUCT   = "s:struct"
	OPT_TAGS     = "t:tags"
	OPT_NO_COLOR = "nc:no-color"
	OPT_HELP     = "h:help"
	OPT_VER      = "v:version"

	OPT_VERB_VER     = "vv:verbose-version"
	OPT_COMPLETION   = "completion"
	OPT_GENERATE_MAN = "generate-man"
)

Constants with options names

const MAX_TYPE_SIZE = 32

MAX_TYPE_SIZE maximum type size

Functions

func Check

func Check(r *report.Report) bool

Check checks report for problems

func PrintFull

func PrintFull(r *report.Report)

PrintFull prints all report info

func PrintStruct

func PrintStruct(r *report.Report, strName string, optimal bool)

PrintStruct prints info about struct

func Run

func Run(gitRev string, gomod []byte)

Run is main CLI function

Types

type Renderer

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

func NewRenderer

func NewRenderer(fields []*report.Field, detailed bool) *Renderer

NewRenderer creates new filed info renderer

func (*Renderer) PrintField

func (r *Renderer) PrintField(f *report.Field)

PrintField prints field info

func (*Renderer) PrintPlaceholder

func (r *Renderer) PrintPlaceholder()

PrintPlaceholder prints placeholder