eslint-config-flowtype-essential

eslint-config-flowtype-essential

Shareable configuration for eslint-plugin-flowtype.

The main idea of this configuration is to be:

1. Strict about syntax
2. Permissive about types
3. Opened for further extensions

Installation

npm install --save-dev eslint-config-flowtype-essential

Then, modify your eslint configuration:

{
  "extends": [
    "flowtype-essential"
  ]
}

Done! Later you can modify your configuration to include any extra rules you need.

Code example

This code is considered valid (and beautiful):

type Client<T> = {
  name: string,
  surname: string,
  age: number | string,
  isRegular: boolean,
  reference: T,
  related: Array<T>,
  preferences: Array<string | Promise<string>>
}

function greetClient (client: Client<string>): string {
  return `Hi, ${client.name}-{$client.reference}`
}

License

MIT.

Changelog

Version 1.0.0

• Fixes peer dependency versions