# README

linebreak

A library for breaking a given text into lines within a specified width. This library also supports per-line indentation.

Import declaration

To use this package in your code, the following import declaration is necessary.

import "github.com/sttk/linebreak"

Usage

The following code breaks the argument text into lines within the terminal width, and outputs them to stdout.

iter := linebreak.New(text, linebreak.TermCols())
for iter.HasNext() {
	line, _ := iter.Next()
	fmt.Println(line)
}

Or

iter := linebreak.New(text, linebreak.TermCols())
for {
	line, exists := iter.Next()
	if !exists {
		break
	}
	fmt.Println(line)
}

Supporting Go versions

This library supports Go 1.18 or later.

Actual test results for each Go version:

% gvm-fav
Now using version go1.18.10
go version go1.18.10 darwin/amd64
ok  	github.com/sttk/linebreak	0.516s	coverage: 95.6% of statements

Now using version go1.19.13
go version go1.19.13 darwin/amd64
ok  	github.com/sttk/linebreak	0.510s	coverage: 95.6% of statements

Now using version go1.20.14
go version go1.20.14 darwin/amd64
ok  	github.com/sttk/linebreak	0.521s	coverage: 95.6% of statements

Now using version go1.21.13
go version go1.21.13 darwin/amd64
ok  	github.com/sttk/linebreak	0.527s	coverage: 95.6% of statements

Now using version go1.22.6
go version go1.22.6 darwin/amd64
ok  	github.com/sttk/linebreak	0.521s	coverage: 95.6% of statements

Back to go1.22.6
Now using version go1.22.6

License

This program is free software under MIT License.
See the file LICENSE in this distribution for more details.