Skip to content

Commit

Permalink
Update Settings docs (#165)
Browse files Browse the repository at this point in the history
Document the `stopOnExit` setting and remove documentation for the `flowDir` setting (which was removed).
  • Loading branch information
nwoltman authored and amilajack committed Feb 24, 2019
1 parent 3ee024d commit 35bdd25
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Expand Up @@ -64,16 +64,19 @@ Also make sure that your `.flowconfig` is in the root of your project directory

**Step 3. Settings (optional)**

Add this line to the 'settings' section of your `.eslintrc` if your `.flowconfig` file is located in a different folder than the execution path of eslint.
Add this line to the 'settings' section of your `.eslintrc` to force the Flow server to stop after it finishes checking types.

```js
"settings": {
"flowtype-errors": {
"flowDir": "./myDir"
"stopOnExit": true
}
},
```

Run `eslint` and and you're all set!
**Step 4. Lint**

Run `eslint` and you're all set!

## Support

Expand Down

0 comments on commit 35bdd25

Please sign in to comment.