cli

package

v2.1.2 Latest Latest Go to latest Published: Apr 1, 2024 License: Apache-2.0 Imports: 23 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/essentialkaos/aligo

Links

Open Source Insights

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 ¶

View Source

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

App info

View Source

const (
	OPT_ARCH     = "a:arch"
	OPT_STRUCT   = "s:struct"
	OPT_TAGS     = "t:tags"
	OPT_PAGER    = "P:pager"
	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

Variables ¶

This section is empty.

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

Source Files ¶

View all Source files

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