gomon

README

Gomon

You can capture file or folder changes, but that's not all.

Gomon saves the last modification dates of the watched files, so it can detect any changes when it is started at a later time.

🎯 Future

• Errors.
• Save the files under the directory.

⚡️ Quickstart

package main

import (
  "log"

  "github.com/ichbinbekir/gomon"
)

func main() {
  watcher, err := gomon.NewWatcher(Config{Save: "dates.json"})
  if err != nil {
    log.Fatal(err)
  }
  defer watcher.Close()

  if _, err := watcher.Add("test.txt"); err != nil {
    log.Fatal(err)
  }

  for {
    select {
    case event, ok := <-watcher.Events:
      if !ok {
        break
      }
      // Print file modifications
      log.Println(event)
    case err := <-watcher.Errors:
      log.Fatal(err)
    }
  }
}

⚙️ Installation

go get -u github.com/ichbinbekir/gomon

Documentation

Index

• type Config
• type Event
  • func (e Event) Has(op Op) bool
  • func (e Event) String() string
• type Op
  • func (o Op) Has(h Op) bool
  • func (o Op) String() string
• type SaveError
  • func (e *SaveError) Error() string
  • func (e *SaveError) Unwrap() error
• type Watcher
  • func NewWatcher(configs ...Config) (*Watcher, error)
  • func (w *Watcher) Add(path string) (Op, error)
  • func (w *Watcher) Close() error
  • func (w *Watcher) Config() Config

Types

type Config

type Config struct {
	// Events and Errors channel buffer size, both fsnotify and gomon.
	BufferSize uint

	// Save files or directories modification dates to file.
	Save string
}

type Event

type Event struct {
	Name string
	Op   Op
}

func (Event) Has

func (e Event) Has(op Op) bool

func (Event) String

func (e Event) String() string

type Op

type Op fsnotify.Op

const (
	// Default fsnotify
	Create Op = 1 << iota
	Write
	Remove
	Rename
	Chmod

	// Special for gomon
	Non Op = 0
)

func (Op) Has

func (o Op) Has(h Op) bool

func (Op) String

func (o Op) String() string

type SaveError

type SaveError struct {
	Op  string // truncate, seek, encode, vb.
	Err error
}

func (*SaveError) Error

func (e *SaveError) Error() string

func (*SaveError) Unwrap

func (e *SaveError) Unwrap() error

type Watcher

type Watcher struct {
	Events chan Event
	Errors chan error
	// contains filtered or unexported fields
}

func NewWatcher

func NewWatcher(configs ...Config) (*Watcher, error)

func (*Watcher) Add

func (w *Watcher) Add(path string) (Op, error)

func (*Watcher) Close

func (w *Watcher) Close() error

func (*Watcher) Config

func (w *Watcher) Config() Config