vendor/github.com/lunixbochs/vtclean/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

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

vtclean
----

Clean up raw terminal output by stripping escape sequences, optionally preserving color.

Get it: `go get github.com/lunixbochs/vtclean/vtclean`

API:

    import "github.com/lunixbochs/vtclean"
    vtclean.Clean(line string, color bool) string

Command line example:

    $ echo -e '\x1b[1;32mcolor example
    color forced to stop at end of line
    backspace is ba\b\bgood
    no beeps!\x07\x07' | ./vtclean -color

    color example
    color forced to stop at end of line
    backspace is good
    no beeps!

Go example:

    package main

    import (
        "fmt"
        "github.com/lunixbochs/vtclean"
    )

    func main() {
        line := vtclean.Clean(
            "\033[1;32mcolor, " +
            "curs\033[Aor, " +
            "backspace\b\b\b\b\b\b\b\b\b\b\b\033[K", false)
        fmt.Println(line)
    }

Output:

    color, cursor