ansialign

package module

v0.0.1 Latest Latest Go to latest Published: May 30, 2022 License: ISC Imports: 3 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

align-text with ANSI support for CLIs

Easily center- or right- align a block of text, carefully ignoring ANSI escape codes.

E.g. turn this:

Into this:

go get github.com/mytchmason/ansialign

Align the given text per the line with the greatest string-width, returning a new string (or array).

Arg	Type	Required
`text`	`string`	✅
`opts`	`struct`	🚫

Options to change behavior, see below

opts.align: string, default 'center'

The alignment mode. Use 'center' for center-alignment, 'right' for right-alignment, or 'left' for left-alignment. Note that the given text is assumed to be left-aligned already, so specifying align: 'left' just returns the text as is (no-op).
opts.split: string, default '\n'

The separator to use when splitting the text. Only used if text is given as a string.
opts.pad: string, default ' '

The value used to left-pad (prepend to) lines of lesser width. Will be repeated as necessary to adjust alignment to the line with the greatest width.

This section is empty.

This section is empty.

func Align(text string, opts AlignOptions) string

type AlignOptions struct {
	Align string
	Split string
	Pad   string
}