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
  • 3 hours ago
  • 5 years ago

Installs

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

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