Flow is a static typechecker for JavaScript. To find out more about Flow, check out flowtype.org.<\/p>\n
For a background on the project, please read our launch blog post.<\/p>\n
Flow works with:<\/p>\n
There are binary distributions for Mac OS X and many variants of Linux; you can also build it from source on almost any 64-bit Linux variant.<\/p>\n
Flow is written in OCaml (OCaml 4.01.0 or higher is required) and (on Linux) requires libelf. You can install OCaml on Mac OS X and Linux by following the instructions at ocaml.org.<\/p>\n
Once you have these dependencies, building Flow just requires running<\/p>\n
make\n<\/code><\/pre>\nThis produces a bin<\/code> folder containing the flow<\/code> binary.<\/p>\nNote: at this time, the OCaml dependency prevents us from adding Flow to npm. Try flow-bin if you need a npm binary wrapper.<\/em><\/p>\nRunning the tests<\/h2>\n
To run the tests first compile flow using make<\/code>. Then run bash .\/runtests.sh bin\/flow<\/code><\/p>\nThere is a make test<\/code> target that compiles and runs tests.<\/p>\nTo run a subset of the tests you can pass a second argument to the runtests.sh<\/code> file.<\/p>\nFor example: bash runtests.sh bin\/flow class | grep -v 'Skipping directory'<\/code><\/p>\nInstalling Flow<\/h2>\n
Flow is simple to install: all you need is the flow<\/code> binary on your PATH and you\u2019re good to go.<\/p>\nUsing OPAM<\/h2>\n
You can also build and install flow via the OCaml OPAM package manager with one command:<\/p>\n
opam install flowtype\n<\/code><\/pre>\nIf you don\u2019t have a new enough version of OCaml to compile Flow, you can also use OPAM to bootstrap a modern version. Install OPAM via the binary packages for your operating system and run:<\/p>\n
opam init --comp=4.01.0\nopam install flowtype\neval `opam config env`\nflow --help\n<\/code><\/pre>\nDocumentation<\/h2>\n
Check out http:\/\/flowtype.org for documentation and examples.<\/p>\n
Join the Flow community<\/h2>\n\n- Website: http:\/\/flowtype.org\/<\/li>\n
- irc: #flowtype on Freenode<\/li>\n
- Twitter: @flowtype and #flowtype to keep up with the latest Flow news.<\/li>\n<\/ul>\n
License<\/h2>\n
Flow is BSD-licensed. We also provide an additional patent grant.<\/p>\n","protected":false},"excerpt":{"rendered":"
Flow is a static typechecker for JavaScript. To find out more about Flow, check out flowtype.org. For a background on the project, please read our launch blog post. Requirements Flow works with: There are binary distributions for Mac OS X and many variants of Linux; you can also build it from source on almost any […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-7965","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/unknownerror.org\/index.php\/wp-json\/wp\/v2\/posts\/7965","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/unknownerror.org\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/unknownerror.org\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/unknownerror.org\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/unknownerror.org\/index.php\/wp-json\/wp\/v2\/comments?post=7965"}],"version-history":[{"count":0,"href":"https:\/\/unknownerror.org\/index.php\/wp-json\/wp\/v2\/posts\/7965\/revisions"}],"wp:attachment":[{"href":"https:\/\/unknownerror.org\/index.php\/wp-json\/wp\/v2\/media?parent=7965"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/unknownerror.org\/index.php\/wp-json\/wp\/v2\/categories?post=7965"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/unknownerror.org\/index.php\/wp-json\/wp\/v2\/tags?post=7965"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}