logger

Documentation

Index

• Constants
• func PrintErrorToStderr(osArgs []string, text string)
• func PrintMessageToStderr(osArgs []string, msg Msg)
• type Loc
• type Log
  • func NewDeferLog() Log
  • func NewStderrLog(options StderrOptions) Log
  • func (log Log) AddError(source *Source, loc Loc, text string)
  • func (log Log) AddRangeError(source *Source, r Range, text string)
  • func (log Log) AddRangeWarning(source *Source, r Range, text string)
  • func (log Log) AddWarning(source *Source, loc Loc, text string)
• type LogLevel
• type Msg
  • func (msg Msg) String(options StderrOptions, terminalInfo TerminalInfo) string
• type MsgDetail
• type MsgKind
• type MsgLocation
• type Path
  • func (a Path) ComesBeforeInSortedOrder(b Path) bool
• type Range
  • func (r Range) End() int32
• type Source
  • func (s *Source) RangeOfNumber(loc Loc) (r Range)
  • func (s *Source) RangeOfString(loc Loc) Range
  • func (s *Source) TextForRange(r Range) string
• type StderrColor
• type StderrOptions
• type TerminalInfo
  • func GetTerminalInfo(file *os.File) (info TerminalInfo)

Constants

const SupportsColorEscapes = true

Functions

func PrintErrorToStderr

func PrintErrorToStderr(osArgs []string, text string)

func PrintMessageToStderr

func PrintMessageToStderr(osArgs []string, msg Msg)

Types

type Loc

type Loc struct {
	// This is the 0-based index of this location from the start of the file, in bytes
	Start int32
}

type Log

type Log struct {
	AddMsg    func(Msg)
	HasErrors func() bool
	Done      func() []Msg
}

func NewDeferLog

func NewDeferLog() Log

func NewStderrLog

func NewStderrLog(options StderrOptions) Log

func (Log) AddError

func (log Log) AddError(source *Source, loc Loc, text string)

func (Log) AddRangeError

func (log Log) AddRangeError(source *Source, r Range, text string)

func (Log) AddRangeWarning

func (log Log) AddRangeWarning(source *Source, r Range, text string)

func (Log) AddWarning

func (log Log) AddWarning(source *Source, loc Loc, text string)

type LogLevel

type LogLevel int8

const (
	LevelNone LogLevel = iota
	LevelInfo
	LevelWarning
	LevelError
)

type Msg

type Msg struct {
	Kind     MsgKind
	Text     string
	Location *MsgLocation
}

func (Msg) String

func (msg Msg) String(options StderrOptions, terminalInfo TerminalInfo) string

type MsgDetail

type MsgDetail struct {
	Path    string
	Line    int
	Column  int
	Kind    string
	Message string

	// Source == SourceBefore + SourceMarked + SourceAfter
	Source       string
	SourceBefore string
	SourceMarked string
	SourceAfter  string

	Indent string
	Marker string

	ContentAfter string
}

type MsgKind

type MsgKind uint8

const (
	Error MsgKind = iota
	Warning
)

type MsgLocation

type MsgLocation struct {
	File     string
	Line     int // 1-based
	Column   int // 0-based, in bytes
	Length   int // in bytes
	LineText string
}

type Path

type Path struct {
	Text      string
	Namespace string
}

This is used to represent both file system paths (Namespace == "file") and abstract module paths (Namespace != "file"). Abstract module paths represent "virtual modules" when used for an input file and "package paths" when used to represent an external module.

func (Path) ComesBeforeInSortedOrder

func (a Path) ComesBeforeInSortedOrder(b Path) bool

type Range

type Range struct {
	Loc Loc
	Len int32
}

func (Range) End

func (r Range) End() int32

type Source

type Source struct {
	Index uint32

	// This is used as a unique key to identify this source file. It should never
	// be shown to the user (e.g. never print this to the terminal).
	//
	// If it's marked as an absolute path, it's a platform-dependent path that
	// includes environment-specific things such as Windows backslash path
	// separators and potentially the user's home directory. Only use this for
	// passing to syscalls for reading and writing to the file system. Do not
	// include this in any output data.
	//
	// If it's marked as not an absolute path, it's an opaque string that is used
	// to refer to an automatically-generated module.
	KeyPath Path

	// This is used for error messages and the metadata JSON file.
	//
	// This is a mostly platform-independent path. It's relative to the current
	// working directory and always uses standard path separators. Use this for
	// referencing a file in all output data. These paths still use the original
	// case of the path so they may still work differently on file systems that
	// are case-insensitive vs. case-sensitive.
	PrettyPath string

	// An identifier that is mixed in to automatically-generated symbol names to
	// improve readability. For example, if the identifier is "util" then the
	// symbol for an "export default" statement will be called "util_default".
	IdentifierName string

	Contents string
}

func (*Source) RangeOfNumber

func (s *Source) RangeOfNumber(loc Loc) (r Range)

func (*Source) RangeOfString

func (s *Source) RangeOfString(loc Loc) Range

func (*Source) TextForRange

func (s *Source) TextForRange(r Range) string

type StderrColor

type StderrColor uint8

const (
	ColorIfTerminal StderrColor = iota
	ColorNever
	ColorAlways
)

type StderrOptions

type StderrOptions struct {
	IncludeSource bool
	ErrorLimit    int
	Color         StderrColor
	LogLevel      LogLevel
}

type TerminalInfo

type TerminalInfo struct {
	IsTTY           bool
	UseColorEscapes bool
	Width           int
}

func GetTerminalInfo

func GetTerminalInfo(file *os.File) (info TerminalInfo)