format

README

Gum Format

Gum format allows you to format different text into human readable output.

Four different parse-able formats exist:

1. Markdown
2. Code
3. Template
4. Emoji

Markdown

Render any input as markdown text. This uses Glamour behind the scenes.

You can pass input as lines directly as arguments to the command invocation or pass markdown over stdin.

gum format --type markdown < README.md
# Or, directly as arguments (useful for quick lists)
gum format --type markdown -- "# Gum Formats" "- Markdown" "- Code" "- Template" "- Emoji"

Code

Render any code snippet with syntax highlighting. Glamour, which uses Chroma under the hood, handles styling.

Similarly to the markdown format, code can take input over stdin.

cat options.go | gum format --type code

Template

Render styled input from a string template. Templating is handled by Termenv.

gum format --type template '{{ Bold "Tasty" }} {{ Italic "Bubble" }} {{ Color "99" "0" " Gum " }}'
# Or, via stdin
echo '{{ Bold "Tasty" }} {{ Italic "Bubble" }} {{ Color "99" "0" " Gum " }}' | gum format --type template 

Emoji

Parse and render emojis from their matching :name:s. Powered by Glamour and Goldmark Emoji

gum format --type emoji 'I :heart: Bubble Gum :candy:'
# You know the drill, also via stdin
echo 'I :heart: Bubble Gum :candy:' | gum format --type emoji 

Documentation

Overview

Package format allows you to render formatted text from the command line.

It supports the following types:

1. Markdown
2. Code
3. Emoji
4. Template

For more information, see the format/README.md file.

Index

• type Func
• type Options
  • func (o Options) Run() error

Types

type Func

type Func func(string) (string, error)

Func is a function that formats some text.

type Options

type Options struct {
	Template []string `arg:"" optional:"" help:"Template string to format (can also be provided via stdin)"`

	Type string `help:"Format to use (markdown,template,code,emoji)" enum:"markdown,template,code,emoji" short:"t" default:"markdown"`
}

Options is customization options for the format command.

func (Options) Run

func (o Options) Run() error

Run runs the format command.