ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Flow

by 73rhodes ST2/ST3

Flow JavaScript analyzer plugin for SublimeText 2 and 3

Labels linting

Details

  • 2015.01.15.20.26.28
  • github.​com
  • github.​com
  • 5 years ago
  • 2 hours ago
  • 5 years ago

Installs

  • Total 10K
  • Win 2K
  • OS X 7K
  • Linux 2K
Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1
Windows 1 2 2 0 0 3 1 0 1 1 3 2 3 2 0 3 2 3 1 1 1 0 0 2 5 3 1 4 2 2 2 1 2 1 3 0 1 6 3 2 2 1 1 3 2 2
OS X 0 0 2 2 2 1 6 0 2 1 2 8 2 1 0 2 4 1 1 3 5 3 0 1 5 3 3 3 2 1 5 3 1 1 4 1 1 2 2 2 6 2 3 1 1 3
Linux 0 1 1 0 0 0 0 1 1 1 0 1 1 0 1 0 1 0 1 0 1 0 1 0 0 0 0 2 0 1 0 0 1 0 2 0 0 0 1 0 1 1 0 0 0 1

Readme

Source
raw.​githubusercontent.​com

Sublime-Flow

A Sublime package for Flow, the static JavaScript analyzer.

  • Run Flow on JavaScript projects from SublimeText
  • Linux and OS X are supported.

Prerequisites

  • Flow must be installed on your system. It's recommended to install flow to /usr/local/bin/.
  • To allow Flow to work in your project directory you must either
    • run flow init in your project directory
    • or create an empty .flowconfig file in your project's root directory

Installation

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

Usage

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.

Any JavaScript files that you want checked with Flow must include the following line in their headers:

/* @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+P on OS X, Control+Shift+P on Linux/Windows), then type Flow.
  • Click the Tools > Flow menu entry.
  • Press CTRL+F.

Using the Flow build system:

  • Set the Build System to Flow, then run Build (Command+B on OSX)
  • Alternately, set the Build System to automatic; the Flow build system will be selected for .js files automatically. If another build system has already been configured to work with .js files, this may not work.

Settings

  • 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