Package detail

eslint-plugin-flowtype-errors

amilajack37k4.5.0

Retrieve Flow errors as ESLint errors.

eslint, flow, plugin, errors

readme

eslint-plugin-flowtype-errors

Test NPM version Dependency Status npm

Demo

ESLint Flow Demo

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: It's 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 text editor or IDE. For atom, see this comment

1. Install

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

2. Configure

Extend the recommended config:

{
  "extends": ["plugin:flowtype-errors/recommended"]
}

Support

If this project is saving you (or your team) time, please consider supporting it on Patreon 👍 thank you!

CI Configuration

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

Related:

changelog

v4.2.0

Added

  • Support for libdefs

    Updated

  • All dependencies to latest semver

v4.1.0

Added

  • Recommended config 🎉

v4.0.0

Fixed

  • Fix Flow >= v0.71 on Windows

    Added

  • Integration with Azure Pipelines

    Updated

  • New config lookup
  • Upgraded babel, flow, eslint, and all other dependencies to latest semver 🎉🎉🎉 (This may introduce breaking changes)

v3.6.0

Updated

  • Bumped all deps to latest semver

v3.5.1

Fixed

  • Fix --json-version=2 support

v3.5.0

Added

  • Added support for >=flow@0.66

v3.4.0

Added

  • Added show-warnings rule.
"flowtype-errors/show-warnings": 1

v3.3.3

Added

  • Improved accuracy of error messages.

    Fixed

  • Show error on 32 bit OS's. Closes #46.
  • Fixed #100.

v3.3.2

Fixed

  • Fixed off-by-one error in reported column numbers.

v3.3.1

  • No interesting changes.

v3.3.0

Added

  • Added enforce-min-coverage rule.
    "flowtype-errors/enforce-min-coverage": [2, 50]
  • Added stopOnExit setting.
    "settings": {
    "flowtype-errors": {
      "stopOnExit": "true"
    }
    },

v3.2.1

Fixed

  • Fixed error when type checking folders with spaces on Windows.

v3.2.0

Added

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

v3.0.3

Fixed

  • Fixed bug that suppressed jsx errors

v3.0.2

Updated

  • flow-bin@0.39.0 -> flow-bin@0.42.0

v3.0.1

Added

  • Support for node >= 4

v3.0.0

Added

v2.0.0

Changed

  • Require flow-bin as a peerDependency
  • Updated all dependencies
  • Migrated to Jest

v1.0.0

Initial stable release