SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Before using this plugin, you must ensure that
flow is installed on your system. To install
flow, follow the instructions here:
In order for this linter to work you will need to run the
flow init command in your project or manually create a
Note: This plugin requires
flow 0.1.0 or later.
In order for
flow to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.
Once you have installed and configured
flow, you can proceed to install the SublimeLinter-flow plugin if it is not yet installed.
Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.
To install via Package Control, do the following:
Within Sublime Text, bring up the Command Palette and type
install. Among the commands you should see
Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.
When the plugin list appears, type
flow. Among the entries you should see
SublimeLinter-flow. If that entry is not highlighted, use the keyboard or mouse to select it.
In addition to the standard SublimeLinter settings, SublimeLinter-flow provides its own settings. Those marked as “Inline Setting” may also be used inline.
|lib||Add a path to your interface files. More info|
|show-all-errors||It allows flow to output all errors instead of stopping at 50|
|coverage||Shows flow coverage warnings||✓|
|all||runs flow against all files regardless of
At this moment, using
all in a medium to big sized node.js project may cause a crash. It's recommended to use
flow incrementally, one file at a time.
Use with caution.
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
- Commit and push the topic branch.
- Make a pull request.
- Be patient. ;-)
Please note that modifications should follow these coding guidelines:
- Indent is 4 spaces.
- Code should pass flake8 and pep257 linters.
- Vertical whitespace helps readability, don’t be afraid to use it.
- Please use descriptive variable names, no abbreviations unless they are very well known.
Thank you for helping out!