jedwards1211 / flow-watch Goto Github PK

clear the console and run flow on file changes

License: MIT License

JavaScript 100.00%

flow watch rerun file-watcher flow-watch

flow-watch's Introduction

flow-watch

A simple file watcher that clears the console and runs flow on each change. Currently tested on OS X -- I don't know if it works on Linux or Windows. Works with flow on your path or flow-bin installed as a peer dependency.

Usage

npm install --save-dev flow-watch

Then run the flow-watch command.

flow-watch passes known nodemon options to nodemon, and all other options to flow.

You may not need this?

nodemon has a documented way to clear the console on restart, so you may want to use nodemon/flow directly in a package script instead of using flow-watch.

To use nodemon and flow, you can add this to your package.json (tested with [email protected]):

{
  "scripts": {
    "flow:watch": "nodemon -x 'flow || exit 1'"
  },
  "nodemonConfig": {
    "events": {
      "start": "cls || clear"
    }
  }
}

Configuration

flow-watch uses nodemon and accepts any command-line options that nodemon does. If you provide no arguments, it uses the following defaults:

--ignore node_modules/ --watch *.js --watch *.jsx --watch *.js.flow --watch .flowconfig

By default, the watcher will clear the console between each change. If you wish to override this behavior, use the FLOW_WATCH_NO_CLEAR_CONSOLE env variable. If you choose that approach, you may also want to silent the [nodemon] messages in the console, which you can do with the --quiet flag (or -q). Putting it all together:

{
  "scripts": {
    "flow:watch": "FLOW_WATCH_NO_CLEAR_CONSOLE=1 flow-watch -q"
  }
}

flow-watch's People

Contributors

Stargazers

Watchers

Forkers

sorahn sahalsaad heartnett brandcast

"scripts": {
  "flow": "nodemon --exec ./flow-clean-exit.sh"
}

Create ./flow-clean-exit.sh (In the root of your project):

#!/bin/bash

clear # Clear the terminal

# Trap, so `nodemon` will continue to work when flow encounters an error
# Otherwise, `flow` changes the process exit code and `nodemon` crashes
trap './node_modules/.bin/flow' EXIT

Run chmod +x ./flow-clean-exit.sh to give it permission to run.

And you're done.

npm run flow and you'll launch this service that'll watch for changes and rerun flow.

passing arguments to flow

Hi, thanks for the great work!

Is it possible to pass arguments to flow binary?
Would be nice to be able to pass options such as --show-all-errors