trigger: Cross platform file system watcher

[ bsd3, library, program, web ] [ Propose Tags ] [ Report a vulnerability ]

Trigger is a cross platform file system watcher for super fast build-and-restart workflows. When files change, it can be configured to: * run build tasks * restart your app in the background

[Skip to Readme]

Modules

[Index]

Downloads

trigger-1.0.0.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

rhyskeepence

For package maintainers and hackage trustees

edit package information

Candidates

No Candidates

Versions [RSS]	1.0.0.0, 1.0.1.0, 1.0.2.0
Dependencies	aeson, ansi-terminal, base (>=4.7 && <5), clock, directory, exceptions, filepath, formatting, fsnotify, Glob, process, protolude, text, time, trigger, twitch, yaml [details]
License	MIT
Copyright	2017 Rhys Keepence
Author	Rhys Keepence
Maintainer	rhys@rhyskeepence.com
Category	Build
Home page	https://github.com/rhyskeepence/trigger
Uploaded	by rhyskeepence at 2017-12-15T15:14:31Z
Distributions
Executables	trigger
Downloads	1860 total (1 in the last 30 days)
Rating	(no votes yet) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs available [build log] Last success reported on 2017-12-15 [all 1 reports]

Readme for trigger-1.0.0.0

[back to package description]

Trigger

Trigger is a cross platform file system watcher for super fast build-and-restart workflows. When files change, it can be configured to:

run build tasks
restart your app in the background

fswatch and others are good general purpose tools for triggering tasks on filesystem changes. However, they don't support stopping and starting background processes.

How does it work?

         -------------------------------
        | start processes in background |
         -------------------------------
                       |
                 wait for change <-----------
                       |                     |
         -------------------------------     |
        |   stop background processes   |    |
         -------------------------------     |
                       |                     |
         -------------------------------     |
        | run build tasks sequentially  |    |
         -------------------------------     |
                       |                     |
         -------------------------------     |
        | start processes in background |    |
         -------------------------------     |
                       |                     |
                        ---------------------

Installation

It's Haskell, so download Stack.

Clone and run stack build --install

This should install trigger on your PATH.

If you get linking issues on Windows, see this issue

Configuration

Create a file named trigger.yaml

Here is an example:

- dirs:
    - "src"
  files:
    - "**/*.hs"
  ignore:
    - "**/Ignored.hs"
  tasks: 
    - "stack build"
  run:
    - command: "project/stack exec"
      workingDir: "project"
      env:
        - ["HOST", "localhost"]
        - ["PORT", "1234"]

Which consists of:

dirs: one or more directories to watch for changes
files: one or more file globs. Files that don't match will not trigger.
ignore: (optional) one or more file globs. Overrides the above file globs to exclude particular files.
tasks: (optional) one or more tasks, which are run sequentially in the foreground. Any error will stop subsequent tasks.
run: (optional) one or more background processes. Note: this executes the command directly, rather than using the shell, to improve shutdown behaviour.
- command: command and arguments to run in background. Note: this command is relative to where you start trigger, not the workingDir.
- workingDir: (optional) override the working directory of the process.
- env: (optional) additional environment variables for the process