cli

package

v0.0.3 Latest Latest Go to latest Published: Jan 3, 2024 License: MIT Imports: 8 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

This section is empty.

This section is empty.

This section is empty.

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

CLI is a wrapper for running the Kin CLI.

func New() *CLI

New creates a new instance of the CLI.

func (cli CLI) Run(args []string) error

Run is the main executable body of the Kin CLI. It handles parsing any arguments and executing the main body.

type Executable interface {
	Execute(app string, args ...string) error
}

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

Watcher allows you to observe directories and call an action if any of them change.

func NewWatcher(watchDirs, ignoreDirs []string) (*Watcher, error)

NewWatcher initializes a new instance of a Watcher. It specifies a list of directories to watch and directories to ignore.

func (w Watcher) Close()

Close stops the filesystem watcher.

func (w *Watcher) Watch(callback WatcherCallback) error

Watch starts the watcher. A callback function is provided that gets executed anytime a file change occurs.

type WatcherCallback func(string) error

WatcherCallback is the function signature that is executed when a file is changed.