https://github.com/gowizzard/baraddur

A small and extreme lightweight file-watcher.
https://github.com/gowizzard/baraddur

file-watcher golang library

Last synced: 9 months ago
JSON representation

A small and extreme lightweight file-watcher.

• Host: GitHub
• URL: https://github.com/gowizzard/baraddur
• Owner: gowizzard
• License: mit
• Created: 2022-10-18T07:57:08.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-20T19:53:14.000Z (over 3 years ago)
• Last Synced: 2025-02-05T02:43:31.524Z (over 1 year ago)
• Topics: file-watcher, golang, library
• Language: Go
• Homepage:
• Size: 33.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          




# Barad-dûr



[![GitHub go.mod Go version of a Go module](https://img.shields.io/github/go-mod/go-version/gowizzard/baraddur.svg)](https://golang.org/) [![Go](https://github.com/gowizzard/baraddur/actions/workflows/go.yml/badge.svg)](https://github.com/gowizzard/baraddur/actions/workflows/go.yml) [![CodeQL](https://github.com/gowizzard/baraddur/actions/workflows/codeql.yml/badge.svg)](https://github.com/gowizzard/baraddur/actions/workflows/codeql.yml) [![CompVer](https://github.com/gowizzard/baraddur/actions/workflows/compver.yml/badge.svg)](https://github.com/gowizzard/baraddur/actions/workflows/compver.yml) [![Go Reference](https://pkg.go.dev/badge/github.com/gowizzard/baraddur.svg)](https://pkg.go.dev/github.com/gowizzard/baraddur) [![Go Report Card](https://goreportcard.com/badge/github.com/gowizzard/baraddur)](https://goreportcard.com/report/github.com/gowizzard/baraddur) [![GitHub issues](https://img.shields.io/github/issues/gowizzard/baraddur)](https://github.com/gowizzard/baraddur/issues) [![GitHub forks](https://img.shields.io/github/forks/gowizzard/baraddur)](https://github.com/gowizzard/baraddur/network) [![GitHub stars](https://img.shields.io/github/stars/gowizzard/baraddur)](https://github.com/gowizzard/baraddur/stargazers) [![GitHub license](https://img.shields.io/github/license/gowizzard/baraddur)](https://github.com/gowizzard/baraddur/blob/master/LICENSE)

This is a small and very lightweight file watcher that can also be used in docker projects. With this file watcher you can watch different files, set the interval of the check and define in a function what should happen with a new mod time of the file.

## Install

First you have to install the package. You can do this as follows:

```console

go get github.com/gowizzard/baraddur

```

## How to use

Here you can find an example of how to use the function. You can define multiple files. For each file you can define the path, the interval of the check and the function to be executed in case of a new modification. It is also possible to define what should happen if an error occurs.

```go

c := baraddur.Config{

    Files: []baraddur.File{

        {

            Path:     "config.go",

            Interval: 1 * time.Second,

            Fault: func(err error) {

                log.Fatalln(err)

            },

            Execute: func() {

                log.Println("Update!")

            },

        },

    },

}

c.Watch()

```

## Special thanks

Thanks to [JetBrains](https://github.com/JetBrains) for supporting me with this and other [open source projects](https://www.jetbrains.com/community/opensource/#support).