jzimmek / eslint-plugin-flowtype-errors

Run Flow as an ESLint plugin

eslint-plugin-flowtype-errors

Demo

NOTE: This demo is using Atom and the packages linter, linter-eslint, language-babel

Why?

• Lower barrier: Any editor that has ESLint support now supports Flow 🎉
• Less editor configuration: No need to change your entire workflow to incorporate flow. No multiple-linters-per-file nonsense.
• Simple: Its literally just an ESLint rule! Just install the dependency, add a flowconfig, and you're good to go!

Getting Started

This guide assumes that you have installed eslint, babel, babel-plugin-transform-flow-strip-types and configured flow. Check out the from-scratch guide for the full guide on getting started.

⚠️ Make sure the 64-bit version of your texteditor/IDE. For atom, see this comment

Step 1. Install

npm install --save-dev eslint-plugin-flowtype-errors

Step 2. Configure

Add this line to the 'rules' section of your .eslintrc

"flowtype-errors/show-errors": 2

Add this line to the 'rules' section of your .eslintrc to enforce a minimum percentage of flow coverage per file (optional). Here's an example of enforcing a converage of at least 50%:

"flowtype-errors/enforce-min-coverage": [2, 50]

Add this line to the 'plugins' section of your .eslintrc

"flowtype-errors"

Add the @flow pragma to files that you want to lint Also make sure that your .flowconfig is in the root of your project directory

/**
 * @flow
 */

Step 3. Settings (optional)

Add this line to the 'settings' section of your .eslintrc if your .flowconfig file is located in a different folder than the execution path of eslint.

"settings": {
  "flowtype-errors": {
    "flowDir": "./myDir"
  }
},

Run eslint and and you're all set!

CI Configuration

Flow is supported on all OS's except Windows 32bit. Add this line to appveyor to make tests run properly.

Editor Configuration

Atom

apm install linter linter-eslint language-babel

Sublime

• https://github.com/SublimeLinter/SublimeLinter3
• https://github.com/roadhump/SublimeLinter-eslint
• https://github.com/babel/babel-sublime

Others

http://eslint.org/docs/user-guide/integrations#editors

Planned Implementations

• Add more extensive tests
• Allow passing arguments to flow binary
• Fix column number inconsistencies between ESLint and Flow
• Run flow minimal amount of times for faster linting
• Custom formatting of flow error messages
• Enable rules to allow and disallow specific flow errors

Related flow tools:

• flow-runtime
• eslint-plugin-flowtype