logger

package
v0.14.15 Latest Latest
Warning

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

 Go to latest Published: Jan 31, 2022 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const SupportsColorEscapes = true

Variables

View Source 
var TerminalColors = Colors{
	Reset:     "\033[0m",
	Bold:      "\033[1m",
	Dim:       "\033[37m",
	Underline: "\033[4m",

	Red:   "\033[31m",
	Green: "\033[32m",
	Blue:  "\033[34m",

	Cyan:    "\033[36m",
	Magenta: "\033[35m",
	Yellow:  "\033[33m",
}

Functions

func PlatformIndependentPathDirBaseExt 

func PlatformIndependentPathDirBaseExt(path string) (dir string, base string, ext string)

This has a custom implementation instead of using "filepath.Dir/Base/Ext" because it should work the same on Unix and Windows. These names end up in the generated output and the generated output should not depend on the OS.

func PrintErrorToStderr 

func PrintErrorToStderr(osArgs []string, text string)

func PrintMessageToStderr 

func PrintMessageToStderr(osArgs []string, msg Msg)

func PrintSummary 

func PrintSummary(useColor UseColor, table SummaryTable, start *time.Time)

func PrintText 

func PrintText(file *os.File, level LogLevel, osArgs []string, callback func(Colors) string)

func PrintTextWithColor 

func PrintTextWithColor(file *os.File, useColor UseColor, callback func(Colors) string)

Types

type APIKind 

type APIKind uint8
const (
	GoAPI APIKind = iota
	CLIAPI
	JSAPI
)
var API APIKind

This can be used to customize error messages for the current API kind

type Colors 

type Colors struct {
	Reset     string
	Bold      string
	Dim       string
	Underline string

	Red   string
	Green string
	Blue  string

	Cyan    string
	Magenta string
	Yellow  string
}

type DeferLogKind 

type DeferLogKind uint8
const (
	DeferLogAll DeferLogKind = iota
	DeferLogNoVerboseOrDebug
)

type LineColumnTracker 

type LineColumnTracker struct {
	// contains filtered or unexported fields
}

It's not common for large files to have many warnings. But when it happens, we want to make sure that it's not too slow. Source code locations are represented as byte offsets for compactness but transforming these to line/column locations for warning messages requires scanning through the file. A naive approach for this would cause O(n^2) scanning time for n warnings distributed throughout the file.

Warnings are typically generated sequentially as the file is scanned. So one way of optimizing this is to just start scanning from where we left off last time instead of always starting from the beginning of the file. That's what this object does.

Another option could be to eagerly populate an array of line/column offsets and then use binary search for each query. This might slow down the common case of a file with only at most a few warnings though, so think before optimizing too much. Performance in the zero or one warning case is by far the most important.

func MakeLineColumnTracker 

func MakeLineColumnTracker(source *Source) LineColumnTracker

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 {
	Level LogLevel

	AddMsg    func(Msg)
	HasErrors func() bool

	// This is called after the build has finished but before writing to stdout.
	// It exists to ensure that deferred warning messages end up in the terminal
	// before the data written to stdout.
	AlmostDone func()

	Done func() []Msg
}

func NewDeferLog 

func NewDeferLog(kind DeferLogKind) Log

func NewStderrLog 

func NewStderrLog(options OutputOptions) Log

func (Log) AddDebug 

func (log Log) AddDebug(tracker *LineColumnTracker, loc Loc, text string)

func (Log) AddDebugWithNotes 

func (log Log) AddDebugWithNotes(tracker *LineColumnTracker, loc Loc, text string, notes []MsgData)

func (Log) AddError 

func (log Log) AddError(tracker *LineColumnTracker, loc Loc, text string)

func (Log) AddErrorWithNotes 

func (log Log) AddErrorWithNotes(tracker *LineColumnTracker, loc Loc, text string, notes []MsgData)

func (Log) AddRangeDebug 

func (log Log) AddRangeDebug(tracker *LineColumnTracker, r Range, text string)

func (Log) AddRangeDebugWithNotes 

func (log Log) AddRangeDebugWithNotes(tracker *LineColumnTracker, r Range, text string, notes []MsgData)

func (Log) AddRangeError 

func (log Log) AddRangeError(tracker *LineColumnTracker, r Range, text string)

func (Log) AddRangeErrorWithNotes 

func (log Log) AddRangeErrorWithNotes(tracker *LineColumnTracker, r Range, text string, notes []MsgData)

func (Log) AddRangeWarning 

func (log Log) AddRangeWarning(tracker *LineColumnTracker, r Range, text string)

func (Log) AddRangeWarningWithNotes 

func (log Log) AddRangeWarningWithNotes(tracker *LineColumnTracker, r Range, text string, notes []MsgData)

func (Log) AddVerbose 

func (log Log) AddVerbose(tracker *LineColumnTracker, loc Loc, text string)

func (Log) AddVerboseWithNotes 

func (log Log) AddVerboseWithNotes(tracker *LineColumnTracker, loc Loc, text string, notes []MsgData)

func (Log) AddWarning 

func (log Log) AddWarning(tracker *LineColumnTracker, loc Loc, text string)

type LogLevel 

type LogLevel int8
const (
	LevelNone LogLevel = iota
	LevelVerbose
	LevelDebug
	LevelInfo
	LevelWarning
	LevelError
	LevelSilent
)

type Msg 

type Msg struct {
	PluginName string
	Kind       MsgKind
	Data       MsgData
	Notes      []MsgData
}

func (Msg) String 

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

type MsgData 

type MsgData struct {
	Text     string
	Location *MsgLocation

	// Optional user-specified data that is passed through unmodified
	UserDetail interface{}
}

func RangeData 

func RangeData(tracker *LineColumnTracker, r Range, text string) MsgData

type MsgDetail 

type MsgDetail struct {
	Path   string
	Line   int
	Column int

	SourceBefore string
	SourceMarked string
	SourceAfter  string

	Indent     string
	Marker     string
	Suggestion string

	ContentAfter string
}

type MsgKind 

type MsgKind uint8
const (
	Error MsgKind = iota
	Warning
	Info
	Note
	Debug
	Verbose
)

func (MsgKind) String 

func (kind MsgKind) String() string

type MsgLocation 

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

func LocationOrNil 

func LocationOrNil(tracker *LineColumnTracker, r Range) *MsgLocation

type OutputOptions 

type OutputOptions struct {
	IncludeSource bool
	MessageLimit  int
	Color         UseColor
	LogLevel      LogLevel
}

func OutputOptionsForArgs 

func OutputOptionsForArgs(osArgs []string) OutputOptions

type Path 

type Path struct {
	Text      string
	Namespace string

	// This feature was added to support ancient CSS libraries that append things
	// like "?#iefix" and "#icons" to some of their import paths as a hack for IE6.
	// The intent is for these suffix parts to be ignored but passed through to
	// the output. This is supported by other bundlers, so we also support this.
	IgnoredSuffix string

	Flags PathFlags
}

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

func (Path) IsDisabled 

func (p Path) IsDisabled() bool

type PathFlags 

type PathFlags uint8
const (
	// This corresponds to a value of "false' in the "browser" package.json field
	PathDisabled PathFlags = 1 << iota
)

type Range 

type Range struct {
	Loc Loc
	Len int32
}

func (Range) End 

func (r Range) End() int32

type SortableMsgs 

type SortableMsgs []Msg

This type is just so we can use Go's native sort function

func (SortableMsgs) Len 

func (a SortableMsgs) Len() int

func (SortableMsgs) Less 

func (a SortableMsgs) Less(i int, j int) bool

func (SortableMsgs) Swap 

func (a SortableMsgs) Swap(i int, j int)

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) RangeOfLegacyOctalEscape 

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

func (*Source) RangeOfNumber 

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

func (*Source) RangeOfOperatorAfter 

func (s *Source) RangeOfOperatorAfter(loc Loc, op string) Range

func (*Source) RangeOfOperatorBefore 

func (s *Source) RangeOfOperatorBefore(loc Loc, op string) Range

func (*Source) RangeOfString 

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

func (*Source) TextForRange 

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

type Span 

type Span struct {
	Text  string
	Range Range
}

type SummaryTable 

type SummaryTable []SummaryTableEntry

This type is just so we can use Go's native sort function

func (SummaryTable) Len 

func (t SummaryTable) Len() int

func (SummaryTable) Less 

func (t SummaryTable) Less(i int, j int) bool

func (SummaryTable) Swap 

func (t SummaryTable) Swap(i int, j int)

type SummaryTableEntry 

type SummaryTableEntry struct {
	Dir         string
	Base        string
	Size        string
	Bytes       int
	IsSourceMap bool
}

type TerminalInfo 

type TerminalInfo struct {
	IsTTY           bool
	UseColorEscapes bool
	Width           int
	Height          int
}

func GetTerminalInfo 

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

type UseColor 

type UseColor uint8
const (
	ColorIfTerminal UseColor = iota
	ColorNever
	ColorAlways
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.