- Linux and OS X are supported.
- Flow must be installed on your system. It's recommended to install
- To allow Flow to work in your project directory you must either
flow initin your project directory
- or create an empty
.flowconfigfile in your project's root directory
Using Package Control:
- Install the Package Control plugin if you don't have it
- Press Ctrl+Shift+P to bring up the Command Palette (or use Tools > Command Palette menu)
- Select Package Control: Install Package
- Type 'Flow' to find Flow for Sublime Text 2 and 3
- Select 'Flow for Sublime Text 2 and 3' to install
Not using Package Control:
- Get files from the package archive
- unzip to your Packages/Flow directory, for example:
- Linux: ~/.config/sublime-text-2/Packages/JSLint
- Mac: ~/Library/Application Support/Sublime Text 2/Packages/JSLint
- Windows: %APPDATA%/Sublime Text 2/Packages/JSLint
- Relaunch Sublime Text
Flow checks entire directories. You must run
flow init in your project directory, or manually create a
.flowconfig file there, before Flow can be used on it.
/* @flow */
Sublime-Flow includes both a command plug-in and a build system.
There are several ways to run the Flow command:
- Bring up the Command Palette (
Command+Shift+Pon OS X,
Control+Shift+Pon Linux/Windows), then type
- Click the Tools > Flow menu entry.
Using the Flow build system:
- Set the Build System to Flow, then run Build (
- Alternately, set the Build System to automatic; the Flow build system will be selected for
.jsfiles automatically. If another build system has already been configured to work with
.jsfiles, this may not work.
- Navigate to Preferences > Package Settings > Flow > Settings - Default.
- To preserve custom settings:
- copy default settings to Preferences > Package Settings > Flow > Settings - User
- modify them to your requirements