Skip to content

Commit 4d6d815

Browse files
SBrown52randycoulman
authored andcommitted
Update flow configuration documentation (facebook#1518)
* Update flow configuration documentation The documentation was missing creating the .flowconfig file * Update flow configuration documentation Adding in suggested changes * Wording * Wording
1 parent ca2dc2d commit 4d6d815

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

packages/react-scripts/template/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,8 @@ To add Flow to a Create React App project, follow these steps:
585585

586586
1. Run `npm install --save-dev flow-bin`.
587587
2. Add `"flow": "flow"` to the `scripts` section of your `package.json`.
588-
3. Add `// @flow` to any files you want to type check (for example, to `src/App.js`).
588+
3. Run `npm run flow -- init` to create a [`.flowconfig` file](https://flowtype.org/docs/advanced-configuration.html) in the root directory.
589+
4. Add `// @flow` to any files you want to type check (for example, to `src/App.js`).
589590

590591
Now you can run `npm run flow` to check the files for type errors.
591592
You can optionally use an IDE like [Nuclide](https://nuclide.io/docs/languages/flow/) for a better integrated experience.

0 commit comments

Comments
 (0)