Getting Flow running

Flow is designed to be introduced to your repo incrementally. That means that you don’t have to add it to your whole codebase all at once. Instead, you can add it file-by-file as you go. Let’s start with something simple to get you going.

First, try to find a file that doesn’t have a lot of complexity or external dependencies. Something with just a handful of plain functions to get started with.

import {getNumberFromString} from "string-math-lib"; export function multiplyStrings(a, b) {

return getNumberFromString(a) * getNumberFromString(b);

}

In order to get Flow running on this file, we need to add a “flow pragma” comment at the top like this:

// @flow import {getNumberFromString} from "string-math-lib"; export function multiplyStrings(a, b) {

return getNumberFromString(a) * getNumberFromString(b);

}

This little comment at the top of the file tells Flow “Okay, I want you to type-check this file”.

Now we need to actually run Flow for the first time. In order to do that, you’ll need to switch back to your terminal and run the following command:

$ flow

Note: This command is an alias of flow status.

What this command does is start up a Flow server and asks it for the “status” of your repo, which will most likely return some errors for you to fix.

The most common errors that you’re gonna see in a new file are:

“Missing annotation”

“Required module not found”

These errors are related to imports and exports. The reason they come up is a result of how Flow works. In order to check types across files, Flow looks directly at the imports and exports of each file.

“Missing annotation”

You’ll see an error like this from Flow because it relates somehow to an export of your file. Other than that Flow won’t complain about missing type annotations.

So in order to fix that, we can start adding some types to your file. For a detailed guide on how to do that see the user guide. What you should end up is with some types like this:

import {getNumberFromString} from "string-math-lib"; export function multiplyStrings(a: string, b: string): number {

return getNumberFromString(a) * getNumberFromString(b);

}

Keep running flow as you add your types to see the effects of what you are doing. Eventually you should be able to clear out all the “Missing annotation” errors.

“Required module not found”

You’ll get these errors whenever you an import/require that can’t be resolved using Node’s normal module algorithm or if you have ignored it with your .flowconfig.

This can be caused by a lot of things, maybe you’re using a special webpack resolver, maybe you forgot to install something. Whatever the reason, Flow needs to be able to find the module you are importing to do its job correctly. You have a couple options on how to solve this:

module.name_mapper — specify a regular expression to match against module names, and a replacement pattern. Create a library definition for the missing module

We’ll focus on creating a library definition for the module, if you need to use module.name_mapper you can see more about it in the documentation.

Creating a library definition

Having library definitions is useful for giving types to the packages you have installed that don’t have types. Let’s set one up for our string-math-lib library from the previous example.

First create a flow-typed directory in your root directory (the directory where you put your .flowconfig).

You can use other directory names using the [lib] section of your .flowconfig. However, using flow-typed will work out of the box.

Now we’ll create a flow-typed/string-math-lib.js file to hold our “libdef” and start it off like this:

declare module "string-math-lib" {

// ...

}

Next we just need to write definitions for exports of that module.

declare module "string-math-lib" {

declare function getNumberFromString(str: string): number

}

Note: If you need to document the “default” or primary export, you can do that with declare module.exports: or declare export default

There’s a lot more to library definitions so you should read through the documentation and read this blog post on how to create high-quality libdefs.

Installing a libdef from flow-typed

Because libdefs can consume a lot of time, we maintain an official repository of high-quality libdefs for all sorts of packages called flow-typed.

To get started with flow-typed, install the command line interface (CLI) globally:

$ npm install --global flow-typed

Now you can look within flow-typed/definitions/npm to see if there’s an existing libdef for a package you want to use, if there is you can install it like this:

$ flow-typed install chalk@1.0.0 --flowVersion 0.30

This tells flow-typed that you want to install the chalk package at the 1.0.0 version when you are running Flow 0.30.

The flow-typed CLI is still in beta and there is a lot of improvements planned for it, so expect this to improve a lot in the near future.

Be sure to contribute back to the flow-typed libdefs. It’s a community effort, and the more people that contribute, the better it gets.

Other errors you might run into:

Hopefully, we’ve covered just about everything that you will run into while getting started with Flow. However, you also might run into some errors like this:

Package inside of node_modules is reporting errors

is reporting errors Reading node_modules is taking a really long time

is taking a really long time Malformed JSON inside node_modules is causing errors

There’s a handful of reasons for these types of errors that I won’t get into in this post (I’m working on detailed documentation for each individual error). For now, in order to keep yourself moving, you can just [ignore] the files that are causing these errors.

This means adding file paths to your [ignore] section in your .flowconfig like this:

[ignore]

./node_modules/package-name/*

./node_modules/other-package/tests/*.json [include] [libs] [options]

There is generally better options than this, but this should give you a good place to start.

For some examples of how to better handle errors within node_modules see this Stack Overflow answer about fbjs.

Pro tip: Checking to see how well you’re covered

If you’re ever wondering how well a file is covered by Flow, you can use the following command to see a coverage report:

$ flow coverage path/to/file.js --color

Additional Resources and Support

There’s lots that was not covered by this article. So here are some links to resources that can help you out.

The Flow team is committed to making sure that everyone has an excellent experience using Flow. If that is ever not true, we’d love to hear from you about how to improve.