strml / sublimelinter-flow

SublimeLinter plugin for JavaScript static type checking, using flow.

SublimeLinter-flow

This linter plugin for SublimeLinter provides an interface to flow, a static type checker for JavaScript. It will be used with files that have the “JavaScript” syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before using this plugin, you must ensure that flow is installed on your system. To install flow, follow the instructions here:

Getting started with Flow

In order for this linter to work you will need to run the flow init command in your project or manually create a .flowconfig file.

Note: This plugin requires flow 0.1.0 or later.

Linter configuration

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.

Plugin installation

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:

1. 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.

2. 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.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

Setting	Description
all	If set to true, the liner will use pass --all to flow check which will check every javascript file regardless of whether they have the /* @flow */ declaration at the top. More info
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
use-server	If set to true, runs flow --no-auto-start instead of flow check. The former fetch results from an existing server (If there is no existing flow server, nothing will be done. You can use flow start to start a server) to speed it up

Warning

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.

Contributing

If you would like to contribute enhancements or fixes, please do the following:

1. Fork the plugin repository.
2. Hack on a separate topic branch created from the latest master.
3. Commit and push the topic branch.
4. Make a pull request.
5. 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!