# flow-watch

> clear the console and run flow on file changes

Latest version **2.0.0** (published 2020-04-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install flow-watch
pnpm add flow-watch
yarn add flow-watch
bun add flow-watch
```

Provides the command `flow-watch`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-04-21 |
| First published | 2016-10-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 29 |
| Author | Andy Edwards |
| Maintainers | jedwards1211 |
| Keywords | flow, watch |

## Links

- npm: https://www.npmjs.com/package/flow-watch
- Repository: https://github.com/jedwards1211/flow-watch
- Homepage: https://github.com/jedwards1211/flow-watch#readme
- Issues: https://github.com/jedwards1211/flow-watch/issues
- npm.io page: https://npm.io/package/flow-watch

## Dependencies (2)

- [nodemon](https://npm.io/package/nodemon.md) ^2.0.3
- [cross-spawn](https://npm.io/package/cross-spawn.md) ^6.0.3

## Recent versions

- 2.0.0 (latest) — 2020-04-21
- 1.1.5 — 2019-10-31
- 1.1.4 — 2018-11-27
- 1.1.3 — 2018-03-17
- 1.1.2 — 2018-02-07
- 1.1.1 — 2017-02-27
- 1.1.0 — 2016-11-30
- 1.0.0 — 2016-10-02

## README

# 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](https://github.com/remy/nodemon/blob/master/faq.md#how-to-clear-the-console-on-restart), so you may want to use `nodemon`/`flow` directly
in a package script instead of using `flow-watch`.

## Configuration

`flow-watch` uses [`nodemon`](https://github.com/remy/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:

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

---
_Source: https://npm.io/package/flow-watch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._