generatecmd

Documentation

Index

• func FileWriter(fileName string, contents []byte) error
• func Run(ctx context.Context, log *slog.Logger, args Arguments) (err error)
• type Arguments
• type FSEventHandler
  • func NewFSEventHandler(log *slog.Logger, dir string, devMode bool, genOpts []generator.GenerateOpt, ...) *FSEventHandler
  • func (h *FSEventHandler) HandleEvent(ctx context.Context, event fsnotify.Event) (result GenerateResult, err error)
  • func (h *FSEventHandler) SetError(fileName string, hasError bool) (previouslyHadError bool, errorCount int)
  • func (h *FSEventHandler) UpsertHash(fileName string, hash [sha256.Size]byte) (updated bool)
  • func (h *FSEventHandler) UpsertLastModTime(fileName string) (modTime time.Time, updated bool)
• type FatalError
  • func (e FatalError) As(target interface{}) bool
  • func (e FatalError) Error() string
  • func (e FatalError) Is(target error) bool
  • func (e FatalError) Unwrap() error
• type FileWriterFunc
  • func WriterFileWriter(w io.Writer) FileWriterFunc
• type Generate
  • func NewGenerate(log *slog.Logger, args Arguments) (g *Generate, err error)
  • func (cmd Generate) Run(ctx context.Context) (err error)
  • func (cmd *Generate) StartProxy(ctx context.Context) (p *proxy.Handler, err error)
• type GenerateResult
• type GenerationEvent

Functions

func FileWriter

func FileWriter(fileName string, contents []byte) error

func Run

func Run(ctx context.Context, log *slog.Logger, args Arguments) (err error)

Types

type Arguments

type Arguments struct {
	FileName                        string
	FileWriter                      FileWriterFunc
	Path                            string
	Watch                           bool
	WatchPattern                    string
	OpenBrowser                     bool
	Command                         string
	ProxyBind                       string
	ProxyPort                       int
	Proxy                           string
	NotifyProxy                     bool
	WorkerCount                     int
	GenerateSourceMapVisualisations bool
	IncludeVersion                  bool
	IncludeTimestamp                bool
	// PPROFPort is the port to run the pprof server on.
	PPROFPort         int
	KeepOrphanedFiles bool
	Lazy              bool
}

type FSEventHandler

type FSEventHandler struct {
	Log *slog.Logger

	Errors []error
	// contains filtered or unexported fields
}

func NewFSEventHandler

func NewFSEventHandler(
	log *slog.Logger,
	dir string,
	devMode bool,
	genOpts []generator.GenerateOpt,
	genSourceMapVis bool,
	keepOrphanedFiles bool,
	fileWriter FileWriterFunc,
	lazy bool,
) *FSEventHandler

func (*FSEventHandler) HandleEvent

func (h *FSEventHandler) HandleEvent(ctx context.Context, event fsnotify.Event) (result GenerateResult, err error)

func (*FSEventHandler) SetError

func (h *FSEventHandler) SetError(fileName string, hasError bool) (previouslyHadError bool, errorCount int)

func (*FSEventHandler) UpsertHash

func (h *FSEventHandler) UpsertHash(fileName string, hash [sha256.Size]byte) (updated bool)

func (*FSEventHandler) UpsertLastModTime

func (h *FSEventHandler) UpsertLastModTime(fileName string) (modTime time.Time, updated bool)

type FatalError

type FatalError struct {
	Err error
}

func (FatalError) As

func (e FatalError) As(target interface{}) bool

func (FatalError) Error

func (e FatalError) Error() string

func (FatalError) Is

func (e FatalError) Is(target error) bool

func (FatalError) Unwrap

func (e FatalError) Unwrap() error

type FileWriterFunc

type FileWriterFunc func(name string, contents []byte) error

func WriterFileWriter

func WriterFileWriter(w io.Writer) FileWriterFunc

type Generate

type Generate struct {
	Log          *slog.Logger
	Args         *Arguments
	WatchPattern *regexp.Regexp
}

func NewGenerate

func NewGenerate(log *slog.Logger, args Arguments) (g *Generate, err error)

func (Generate) Run

func (cmd Generate) Run(ctx context.Context) (err error)

func (*Generate) StartProxy

func (cmd *Generate) StartProxy(ctx context.Context) (p *proxy.Handler, err error)

type GenerateResult

type GenerateResult struct {
	// Updated indicates that the file was updated.
	Updated bool
	// GoUpdated indicates that Go expressions were updated.
	GoUpdated bool
	// TextUpdated indicates that text literals were updated.
	TextUpdated bool
}

type GenerationEvent

type GenerationEvent struct {
	Event       fsnotify.Event
	Updated     bool
	GoUpdated   bool
	TextUpdated bool
}