Skip to content

Commit 35bdd25

Browse files
nwoltmanamilajack
authored andcommitted
Update Settings docs (#165)
Document the `stopOnExit` setting and remove documentation for the `flowDir` setting (which was removed).
1 parent 3ee024d commit 35bdd25

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,19 @@ Also make sure that your `.flowconfig` is in the root of your project directory
6464

6565
**Step 3. Settings (optional)**
6666

67-
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.
67+
Add this line to the 'settings' section of your `.eslintrc` to force the Flow server to stop after it finishes checking types.
68+
6869
```js
6970
"settings": {
7071
"flowtype-errors": {
71-
"flowDir": "./myDir"
72+
"stopOnExit": true
7273
}
7374
},
7475
```
7576

76-
Run `eslint` and and you're all set!
77+
**Step 4. Lint**
78+
79+
Run `eslint` and you're all set!
7780

7881
## Support
7982

0 commit comments

Comments
 (0)