rice-hiroko / linter-flowtype

Lightweight flow linting, autocomplete, outline, and hyperclick for Atom

linter-flowtype

Lightweight Flow integration for Atom. The package provides linting, autocomplete suggestions, outline support, and jump-to-declaration.

Installation

Either search for linter-flowtype in the editor UI or install via apm:

apm install linter-flowtype

Features

• Linting (on save or as-you-type)
• Autocomplete
• Outline support using Atom IDE
• Jump to declaration using Hyperclick (or Atom IDE)
• Datatips using Atom IDE

Settings

Settings can be configured either in the Preferences or by editing ~/.atom/config.cson:

'linter-flowtype':
  lintOnChange: true
  onlyLintIfConfigExists: true
  showUncovered: false
  executablePath: ''
  useLocalFlowBin: true
  hyperclickPriority: 0

• lintOnChange - if disabled, linting will only happen when a file is saved
• onlyLintIfConfigExists - only lint if a .flowconfig file exists
• showUncovered - if enabled, display uncovered lines
• executablePath - if set, this path will be used to run flow (otherwise it will use flow from the PATH or from node_modules)
• useLocalFlowBin - if true, it will look for flow installed in the local node_modules hyperclickPriority - the priority of Hyperclick suggestions

Alternatives

The motivation for the creation of this package was to support as-you-type linting in addition to other integrations like using flow from node_modules, autocomplete, and outline support. It began as a fork of flow-ide, incorporating features from many other packages.

Alternatives to this package include:

• Nuclide - a fully-featured IDE, but comes with many unnecessary features if you only need a lightweight Flow integration (support for other languages, a replacement UI, etc.)
• ide-flow - this package started as a fork of ide-flow, adding linting as-you-type, outline support, and additional configuration options
• linter-flow - this package supports as-you-type linting, but is missing all other features and doesn't display the full flow error message details on error
• autocomplete-flow - only adds autocomplete support

License and Credits

This project is MIT licensed - see LICENSE.

This project makes use of code from several other open-source Atom Flow packages, primarily flow-ide and linter-flow. Original copyright notices appear in LICENSE.