A high level file watcher DSL

License: MIT

Language: Haskell

Hackage travis build status

Twitch is monadic DSL and library for file watching. It conveniently utilizes 'do' notation in the style of Shake and clay to expose the functionality of the fsnotify cross-platform file system watcher.

Here is an example that converts Markdown files to Html and reloads Safari whenever the input files change.

{-# LANGUAGE OverloadedStrings #-}
import Twitch
import System.Process ( system )

main = defaultMain $ do
   "*.md"   |> \filePath -> system ("pandoc -t html " ++ filePath)
   "*.html" |> \_ -> system "osascript refreshSafari.AppleScript"

Rules are specified in the Dep (for Dependency) monad. The library takes advantage of the OverloadedStrings extension to create a Dep value from a glob pattern.

After creating a Dep value using a glob, event callbacks are added using prefix or infix API.

There are three types of events, add, modify and delete. In many cases, the add and modify responses are the same, so an 'add and modify' API is provided

In the example above an 'add and modify' callback was added to both the ".md" and ".html" globs using the |> operator.

All this is the common case, differing callbacks can be added with |+ (or add) and |% (or modify) functions. Finally, delete callbacks are added with |- (of delete).

Here is a more complex usage example, handling all three events seperately.

handleHaskellFiles :: Dep
handleHaskellFiles = "src/**/*.hs" |+ addToCabalFile |% reloadFile |- removeFromCabalFile

Here is another complex example, using the named addModify and delete callbacks to the same function, which build a pdf and a Word document using pandoc, and refreshes a mupdf window.

buildPDFandWordandRefreshWindow _ = do
  pdfLatexCode <- system "pdflatex --interaction errorstopmode -file-line-error -halt-on-error document.tex"
  (pandocCode,pandocOut,pandocErr) <- readProcessWithExitCode "pandoc" [ "--from=latex" , "--to=docx" , "document.tex" , "-o" , "document.docx" ] ""
  (xwininfoCode,xwininfoOut,xwininfoErr) <- readProcessWithExitCode "xwininfo" ["-root", "-int", "-all"] ""
  let windowId = head . words . head . filter (isInfixOf "document") $ lines xwininfoOut
  (xDoToolCode,xDoToolOut,xDoToolErr) <- readProcessWithExitCode "xdotool" ["key", "--window", windowId, "r"] ""
  return ()

main :: IO ()
main = defaultMain $ do
  addModify buildPDFandWordandRefreshWindow "src/**/*.tex"
  delete    buildPDFandWordandRefreshWindow "src/**/*.tex"

The globs in the above two examples are also more complicated and incorporate recursive wildcards. For complete documentation on the glob syntax, consult the Glob library's documentation.

Since a command pattern is calling system commands with a file path, a useful addition to twitch is the file-command-qq quasiquoter, which is the package of the same name.

Here is a slightly more complicated version the example from earlier, using the file-command-qq quasiquoter.

{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE QuasiQuotes #-}
import Twitch
import FileCommand

main = defaultMain $ do
   "*.md"    |> [s|pandoc -t html -o$directory$basename-test.html $path|]
   "*.html"  |> [s|osascript refreshSafari.AppleScript|]

For an alternative command line interface take a look at twitch-cli

Project Statistics

Sourcerank 7
Repository Size 1.91 MB
Stars 35
Forks 7
Watchers 9
Open issues 6
Dependencies 20
Contributors 5
Tags 8
Last updated
Last pushed

Top Contributors See all

Jonathan Fischoff menelaos Elliot Cameron Dmitry Malikov Amiri Barksdale

Packages Referencing this Repo

Twitch is a monadic DSL and library for file watching. It conveniently utilizes do notation in th...
Latest release - Updated - 35 stars

Recent Tags See all

v0.1.7.2 December 12, 2018
v0.1.7.2 December 12, 2018
v0.1.7.1 August 16, 2016
v0.1.7.0 January 18, 2016
v0.1.6.1 December 26, 2014
v0.1.6.0 December 26, 2014
v0.1.5.1 December 23, 2014
v0.1.5.0 December 23, 2014

Something wrong with this page? Make a suggestion

Last synced: 2018-12-12 16:17:56 UTC

Login to resync this repository