liberrors

README

Errors Library

Detailed, pretty-printed colorful errors for Go.

Check out the test/ directory for examples.

────────────────────────────────
 [!] Internal Error
    in nested_file.txt:0:2
    └─ from /tmp/some/path/to/a/file.txt:6:9

    5 |  Hello World
    6 |  testing <——

 >>> This is an example error body

Documentation

Index

• Constants
• type Buffer
  • func (buffer Buffer) IsEmpty() bool
  • func (buffer Buffer) Print(writer io.Writer)
• type Context
• type DetailedError
  • func NewIO(err error, path string) *DetailedError
  • func (err *DetailedError) Error() string
  • func (err *DetailedError) Print(writer io.Writer)
• type DirContext
  • func NewDirContext(path string) DirContext
  • func (context DirContext) Print(writer io.Writer)
• type FileContext
  • func (context FileContext) Print(writer io.Writer)
• type TraceItem
  • func (item TraceItem) PrintNested(writer io.Writer)
  • func (item TraceItem) PrintRoot(writer io.Writer)

Constants

const (
	ERR_INTERNAL = "Internal Error"
	ERR_ASSERT   = "Assertion Error"
	ERR_IO       = "I/O Error"
	ERR_READ     = "Reading Error"
	ERR_WRITE    = "Writing Error"
	ERR_SYNTAX   = "Syntax Error"
	ERR_FORMAT   = "Formatting Error"
	ERR_VALIDATE = "Validation Error"
	ERR_EXECUTE  = "Execution Error"
	ERR_CONVERT  = "Conversion Error"
)

Suggested values for DetailedError.Label

Types

type Buffer

type Buffer struct {
	FirstLine   uint
	Buffer      string
	Highlighted string
}

func (Buffer) IsEmpty

func (buffer Buffer) IsEmpty() bool

func (Buffer) Print

func (buffer Buffer) Print(writer io.Writer)

type Context

type Context interface {
	Print(io.Writer)
}

type DetailedError

type DetailedError struct {
	Label   string
	Context Context
	Details string
}

func NewIO

func NewIO(err error, path string) *DetailedError

Constructor for the most common error

func (*DetailedError) Error

func (err *DetailedError) Error() string

func (*DetailedError) Print

func (err *DetailedError) Print(writer io.Writer)

type DirContext

type DirContext struct {
	Path string
}

func NewDirContext

func NewDirContext(path string) DirContext

func (DirContext) Print

func (context DirContext) Print(writer io.Writer)

type FileContext

type FileContext struct {
	Trace  []TraceItem
	Buffer Buffer
}

func (FileContext) Print

func (context FileContext) Print(writer io.Writer)

type TraceItem

type TraceItem struct {
	Name string
	// Use negative values to hide it from the output
	Col, Row int
}

func (TraceItem) PrintNested

func (item TraceItem) PrintNested(writer io.Writer)

func (TraceItem) PrintRoot

func (item TraceItem) PrintRoot(writer io.Writer)