spinner

README

spinner

Package spinner implements text spinner. Useful for generating semirandom text.

Features

• Supported brackets: curly {} and square []
• Supported text separators: | and ~
• Unlimited nesting

Example

text := "{Hello|Big} {world|people}!"
fmt.Println(spinner.Spin(text))
// Possible outputs: 
//   Hello world!
//   Big world!
//   Hello people!
//   Big people!

Requests or bugs?

https://github.com/gosimple/spinner/issues

Installation

go get -u github.com/gosimple/spinner

License

The source files are distributed under the Mozilla Public License, version 2.0, unless otherwise noted.
Please read the FAQ if you have further questions regarding the license.

Documentation

Overview

Package spinner implements text spinner. Useful for generating semirandom text.

Features:

• Supported brackets: curly `{}` and square `[]`
• Supported text separators: `|` and `~`
• Unlimited nesting

Example:

text := "{Hello|Big} {world|people}!"
fmt.Println(spinner.Spin(text))
// Possible outputs:
//   Hello world!
//   Big world!
//   Hello people!
//   Big people!

Requests or bugs?

https://github.com/gosimple/spinner/issues

Index

• func Spin(text string) (spinned string)

Functions

func Spin

func Spin(text string) (spinned string)

Spin returns a spinned text.