https://github.com/posener/formatter

A library for formatting text - indenting and line wrapping
https://github.com/posener/formatter

format go golang indent line text width wrap

Last synced: 19 days ago
JSON representation

A library for formatting text - indenting and line wrapping

• Host: GitHub
• URL: https://github.com/posener/formatter
• Owner: posener
• License: apache-2.0
• Created: 2019-11-02T21:05:39.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-11-29T15:38:50.000Z (almost 5 years ago)
• Last Synced: 2024-10-05T12:42:47.008Z (about 1 month ago)
• Topics: format, go, golang, indent, line, text, width, wrap
• Language: Go
• Homepage:
• Size: 12.7 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# formatter

[![Build Status](https://travis-ci.org/posener/formatter.svg?branch=master)](https://travis-ci.org/posener/formatter)

[![codecov](https://codecov.io/gh/posener/formatter/branch/master/graph/badge.svg)](https://codecov.io/gh/posener/formatter)

[![GoDoc](https://godoc.org/github.com/posener/formatter?status.svg)](http://godoc.org/github.com/posener/formatter)

[![goreadme](https://goreadme.herokuapp.com/badge/posener/formatter.svg)](https://goreadme.herokuapp.com)

formatter is a library for formatting text.

The `Formatter` wraps an `io.Writer` and formats text written to it. It enables text indenting

and line width wrapping.

#### Examples

```golang

// Create a new formatter.

f := Formatter{

    // For formatter wraps a writer. The writer is where the output will be written to.

    Writer: os.Stdout,

    // Define text indentation. This could be spaces, tabs or any other character set. It will

    // be inserted in the beginning of the text and after every new line. Leave it nil for not

    // indenting the text.

    Indent: []byte(">  "),

    // Width defines line width for applying line wrap. Any non-positive number will be ignored.

    Width: 80,

}

// Writing into the formatter will result in the formatted text being written into the defined

// `Formatter.Writer`.

_, err := f.Write([]byte(loremIpsum))

if err != nil {

    // Handle error :-)

    panic("failed writing Lorem Ipsum")

}

```

 Output:

```

>  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod

>  tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,

>  quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo

>  consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse

>  cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non

>  proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

```

---

Created by [goreadme](https://github.com/apps/goreadme)