Skip to content
Run Flow as an ESLint plugin
JavaScript Vue
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create FUNDING.yml May 24, 2019
flow-typed/npm Bumped deps, fixed failing test cases (#99) Oct 2, 2017
src add recommended eslint config (#170) Mar 22, 2019
test add recommended eslint config (#170) Mar 22, 2019
.editorconfig Updated deps and configs (#64) Jan 28, 2017
.eslintignore Bumped deps, fixed failing test cases (#99) Oct 2, 2017
.flowconfig bumped deps (#127) Aug 29, 2018
.gitattributes Fix #95 (#111) Jan 11, 2018
.gitignore
CHANGELOG.md add recommended eslint config (#170) Mar 22, 2019
LICENSE Dev master (#12) Oct 1, 2016
README.md add recommended eslint config (#170) Mar 22, 2019
azure-pipelines.yml initial migration to azure (#160) Feb 23, 2019
flow-demo.gif Added gif demo Sep 24, 2016
index.js initial migration to azure (#160) Feb 23, 2019
package.json Update dependency eslint to v5.16.0 Jun 22, 2019
yarn.lock Update dependency eslint to v5.16.0 Jun 22, 2019

README.md

eslint-plugin-flowtype-errors

Build Status 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: 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 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:

You can’t perform that action at this time.