vtclean

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 1, 2019 License: MIT Imports: 5 Imported by: 127

README

Build Status

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Clean

func Clean(line string, color bool) string

func NewReader

func NewReader(r io.Reader, color bool) io.Reader

func NewWriter

func NewWriter(w io.Writer, color bool) io.WriteCloser

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL