Starting a new Flow project

One of the most powerful ways to use Flow is to have it checking your code from the first line you write. This allows you to ensure type safety from the very beginning and reduce the likelihood of errors, even while prototyping.

Setting up your project

To set up a new project using Flow, all you need to do is initialize the root of the folder to tell Flow to start typechecking files within your project:

$> mkdir new_project
$> cd new_project
$> flow init

All this actually does is create a hidden file .flowconfig at the root of the folder. You might have noticed that this file was already present in each of the examples we looked at earlier.

Once the .flowconfig file is present, you can run ad-hoc checks on the code within it and its subfolders:

$> flow check

Although this works, it is not the most efficient way to use Flow. This command causes flow to re-check the entire project’s file structure every time. Instead, we recommend you use the flow server:

Using the Flow server

For a large project, you probably only want Flow to recheck files incrementally when they change. Flow uses a client/server architecture which allows you to start a Flow server that will run in the background and type check files as they change. To do this simply run:

$> flow   # This starts a server and prints the initial type check results

You can then check the status of the server again later with the same command:

$> flow   # Connect to the running server and print the type check results

And once you’ve changed some files, you can quickly run it again to see the current state of the type check results:

$> flow   # Connect to server (or start one) and print type check results

Using the flow command with a running server reduces the overhead of having to re-check all files in the project each time you make a change. This allows for a much faster incremental workflow - not to mention a better integration with IDEs and other tools.

When you’ve finished working on your code, you can shutdown the server:

$> flow stop

Typechecking your files

As with all the examples in the Flow tutorial, you need to add

/* @flow */

to the top of each file you’d like Flow to typecheck. You don’t have to do this for all files at once, since Flow will just ignore files that do not have this comment. This allows you to convert your project progressively, one file at a time, and get the benefit of typing gradually. No need to convert your whole project at once.

It is possible to indicate on the command line that you would like Flow to check all JavaScript files, regardless of whether they have the /* @flow */ declaration at the top. To do this, use the --all flag:

$> flow check --all

However, use this command cautiously, particularly if you are running Flow against a large existing project or a project with many large third party frameworks or test suites. The chances are that the checker will find a lot of errors or hazards, and it can be a little overwhelming!

A more valuable approach to converting an existing project is to incrementally check - and fix - the project one file at a time. When you’re ready to convert a file, simply add the /* @flow */ declaration at the top of the file and run the flow command to see if any errors were discovered.

Read more about testing existing libraries or code in the Running Flow on existing code section of this guide.

Common Issues

As Flow starts to typecheck your files you may run into type errors. Check out the Troubleshooting section for common errors and how to resolve them. Your goal is to get the number of errors down to zero as fast as possible so you can continue on with your development.

In some cases, errors may be due to inherent imprecision of the analysis - which means Flow won’t always get it right and could give errors that are false positives. In those cases you can either try to refactor your code to help Flow understand it, or you can use the any type to tell Flow about values that should not be checked.

© 2013–present Facebook Inc.
Licensed under the BSD License.