owl

package module
v0.0.0-...-fb0cb7b Latest Latest
Warning

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

Go to latest
Published: Feb 18, 2017 License: MIT Imports: 1 Imported by: 0

README

Owl

image

Build Status Coverage Status

Overview

🚀-speed file-watcher written in Golang, Owl is mostly suitable as an automatic build/run/test tool.

##Installation

$ go get github.com/flowup/owl/cmd/owl # this will install the binary in $GOBIN

Usage

You can use owl to simply run tests when anything within the current folder(recursively) changes. The -i flag will ignore a directory named bin

$ owl -r 'go test ./...' -i bin
Flags
  • -i or --ignore to ignore files and folders (default: vendor, node_modules, bower_components, .glide, .git)
  • -r or --run for specific command
  • -d or --debounce debounce time for filesystem events before command execution in miliseconds (default 500)
  • -f or --filter files are filtered by regular expression
Config file owl.yaml

You can set default settings for the owl command within the folder with config file.

🤖 Note that any environment variables and flags will override this configuration

run: "echo \"Hello Owl!\""
debounce: 100
verbose: true
ignore:
 - "vendor"
 - "bin"
filter: "go$"

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Debounce

func Debounce(jobs <-chan Job, amount int64) <-chan Job

Debounce debounces the channel of jobs by the given amount of milliseconds ToDO: the for cycle will never stop until the application stops. May be potential leak in a future

func Scheduler

func Scheduler(jobs <-chan Job) <-chan error

Scheduler continually runs jobs read from the jobs channel. If any job is running within the scheduler, it will be killed and replaced by the next job

Types

type Job

type Job interface {
	Start() error
	Stop() error
}

Job interface implements method Start, and Stop. Start runs command and Stop sends kill signal

Directories

Path Synopsis
cmd
owl

Jump to

Keyboard shortcuts

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