https://github.com/manifoldco/ansiwrap

ANSI escape sequence / unicode aware text wrapping for Go
https://github.com/manifoldco/ansiwrap

ansi-colors ansi-escape-sequence cli

Last synced: 12 months ago
JSON representation

ANSI escape sequence / unicode aware text wrapping for Go

• Host: GitHub
• URL: https://github.com/manifoldco/ansiwrap
• Owner: manifoldco
• License: bsd-3-clause
• Created: 2017-01-25T15:57:47.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-01-12T13:19:33.000Z (over 6 years ago)
• Last Synced: 2025-05-08T08:03:23.305Z (about 1 year ago)
• Topics: ansi-colors, ansi-escape-sequence, cli
• Language: Go
• Homepage: https://godoc.org/github.com/manifoldco/ansiwrap
• Size: 449 KB
• Stars: 10
• Watchers: 26
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# `ansiwrap`

ANSI escape sequence / unicode aware text wrapping for Go.

[Code of Conduct](./CODE_OF_CONDUCT.md) |

[Contribution Guidelines](./.github/CONTRIBUTING.md)

[![GitHub release](https://img.shields.io/github/tag/manifoldco/ansiwrap.svg?label=latest)](https://github.com/manifoldco/ansiwrap/releases)

[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/github.com/manifoldco/ansiwrap)

[![Travis](https://img.shields.io/travis/manifoldco/ansiwrap/master.svg)](https://travis-ci.org/manifoldco/ansiwrap)

[![Go Report Card](https://goreportcard.com/badge/github.com/manifoldco/ansiwrap)](https://goreportcard.com/report/github.com/manifoldco/ansiwrap)

[![License](https://img.shields.io/badge/license-BSD-blue.svg)](./LICENSE.md)

## Why `ansiwrap`?

![](./.img/ansiwrap_comparison.png)

> Old text wrappers can't handle ANSI escape sequence formatting,

> but `ansiwrap` knows what to do!

## Features

- ANSI escape sequence aware

- unicode aware

- Greedy and balanced text wrapping

- Flexible indenting

## Example

### Screenshot

![](./.img/cupcake_ipsum.png)

### Code

```go

package main

import (

	"fmt"

	"github.com/manifoldco/ansiwrap"

)

// text including ANSI formatting

const text = "Sweet jujubes tootsie roll cotton candy lollipop. Marzipan donut" +

	" gummies tiramisu fruitcake sesame snaps icing danish.  Ice cream sesame snaps" +

	" candy lemon drops toffee oat cake pastry gummies soufflé. Candy chocolate cake" +

	" ice cream tiramisu \033[35mmarshmallow\033[0m sesame snaps" +

	" \033[35mmarshmallow\033[0m tootsie roll. Pastry cupcake biscuit. Tiramisu" +

	" chocolate sweet sugar plum. Pastry cupcake tart chocolate cake gingerbread" +

	" toffee cake gummi bears oat cake. Icing ice cream danish danish bonbon" +

	" \033[35mmarshmallow\033[0m \033[35mmarshmallow\033[0m gummi bears chocolate bar." +

	" Sesame snaps icing chocolate liquorice macaroon sugar plum macaroon ice cream." +

	" Tootsie roll sugar plum oat cake jelly toffee. Sweet cotton candy candy" +

	" caramels carrot cake cotton candy tiramisu gummies cheesecake. Sweet marzipan" +

	" topping jujubes sesame snaps. Cupcake cake jelly beans candy canes ice cream" +

	" jelly gummies."

func main() {

	// Add your favorite ANSI escape code library, and terminal width reporter.

	// A bold and blue label

	label := "\033[1;34mCupcake ipsum:\033[0m "

	// count the printable characters in label

	rc := ansiwrap.RuneCount(label)

	// Wrap the text to 80 chars, aligning with the end of the label

	// Lines are wrapped with minimal raggedness, as the text is long enough

	// to have ansiwrap choose the Balanced algorithm.

	fmt.Println(ansiwrap.WrapIndent(label+text, 70, 0, rc))

}

```

For more examples and documentation, see the

[GoDoc reference](https://godoc.org/github.com/manifoldco/ansiwrap)