gaper

package

v0.0.0-...-f683405 Latest Latest Go to latest Published: May 30, 2020 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/iesreza/io

Links

Open Source Insights

Documentation ¶

Overview ¶

Package gaper implements a supervisor restarts a go project when it crashes or a watched file changes

Index ¶

Constants
Variables
func Run(cfg *Config, chOSSiginal chan os.Signal) error
type Builder
- func NewBuilder(dir string, bin string, wd string, buildArgs []string) Builder
type Config
type Runner
- func NewRunner(wStdout io.Writer, wStderr io.Writer, bin string, args []string) Runner
type Watcher
- func NewWatcher(cfg WatcherConfig) (Watcher, error)
type WatcherConfig

Constants ¶

View Source

const OSWindows = "windows"

OSWindows is used to check if current OS is a Windows

Variables ¶

View Source

var (
	NoRestartOnError   = "error"
	NoRestartOnSuccess = "success"
	NoRestartOnExit    = "exit"
)

No restart types

View Source

var DefaultBuildPath = "."

DefaultBuildPath is the default build and watched path

View Source

var DefaultExtensions = []string{"go", "yml"}

DefaultExtensions is the default watched extension

View Source

var DefaultPoolInterval = 500

DefaultPoolInterval is the time in ms used by the watcher to wait between scans

Functions ¶

func Run ¶

func Run(cfg *Config, chOSSiginal chan os.Signal) error

Run starts the whole gaper process watching for file changes or exit codes and restarting the program

Types ¶

type Builder ¶

type Builder interface {
	Build() error
	Binary() string
}

Builder is a interface for the build process

func NewBuilder ¶

func NewBuilder(dir string, bin string, wd string, buildArgs []string) Builder

NewBuilder creates a new builder

type Config ¶

type Config struct {
	BinName              string
	BuildPath            string
	BuildArgs            []string
	BuildArgsMerged      string
	ProgramArgs          []string
	ProgramArgsMerged    string
	WatchItems           []string
	IgnoreItems          []string
	PollInterval         int
	Extensions           []string
	NoRestartOn          string
	DisableDefaultIgnore bool
	WorkingDirectory     string
}

Config contains all settings supported by gaper

type Runner ¶

type Runner interface {
	Run() (*exec.Cmd, error)
	Kill() error
	Errors() chan error
	Exited() bool
	IsRunning() bool
	ExitStatus(err error) int
}

Runner is a interface for the run process

func NewRunner ¶

func NewRunner(wStdout io.Writer, wStderr io.Writer, bin string, args []string) Runner

NewRunner creates a new runner

type Watcher ¶

type Watcher interface {
	Watch()
	Errors() chan error
	Events() chan string
}

Watcher is a interface for the watch process

func NewWatcher ¶

func NewWatcher(cfg WatcherConfig) (Watcher, error)

NewWatcher creates a new watcher

type WatcherConfig ¶

type WatcherConfig struct {
	DefaultIgnore bool
	PollInterval  int
	WatchItems    []string
	IgnoreItems   []string
	Extensions    []string
}

WatcherConfig defines the settings available for the watcher

Source Files ¶

View all Source files

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