eslint-plugin-flowtype
Advanced tools
Package description
eslint-plugin-flowtype is an ESLint plugin that provides linting rules for Flow type annotations. It helps ensure that your Flow type annotations are correct and consistent, improving the reliability and maintainability of your code.
Type Annotations
This rule ensures that every file has a valid Flow file annotation. The code sample demonstrates a simple function with Flow type annotations for the parameters and return type.
/* eslint flowtype/require-valid-file-annotation: [2, "always"] */
// @flow
function add(a: number, b: number): number {
return a + b;
}Type Definitions
This rule ensures that all Flow type definitions are defined correctly. The code sample shows a type definition for a User object and an instance of that type.
/* eslint flowtype/define-flow-type: 2 */
// @flow
type User = {
name: string,
age: number
};
const user: User = { name: 'John', age: 30 };Type Casting
This rule enforces a naming convention for type identifiers. The code sample demonstrates a type definition that follows the specified naming convention.
/* eslint flowtype/type-id-match: [2, "^([A-Z][a-z0-9]+)+Type$"] */
// @flow
type UserType = {
name: string,
age: number
};
const user: UserType = { name: 'John', age: 30 };eslint-plugin-typescript is an ESLint plugin that provides linting rules for TypeScript code. It offers similar functionality to eslint-plugin-flowtype but is designed for TypeScript instead of Flow. It helps ensure that your TypeScript code is correct and consistent.
typescript-eslint is a set of tools that allows ESLint to lint TypeScript code. It includes an ESLint plugin and a parser that can handle TypeScript syntax. Like eslint-plugin-flowtype, it helps maintain code quality and consistency, but it is tailored for TypeScript.
Readme
Flow type linting rules for ESLint.
babel-eslint parser (ESLint parser does not support type annotations).eslint-plugin-flowtype plugin.npm install eslint
npm install babel-eslint
npm install eslint-plugin-flowtype
parser property to babel-eslint.plugins section and specify eslint-plugin-flowtype as a plugin.{
"parser": "babel-eslint",
"plugins": [
"flowtype"
],
"rules": {
"flowtype/require-parameter-type": 1,
"flowtype/require-return-type": 1,
"flowtype/space-after-type-colon": 1,
"flowtype/space-before-type-colon": 1
}
}
require-parameter-typeRequires that all function parameters have type annotations.
The following patterns are considered problems:
(foo) => {}
// Message: Missing "foo" parameter type annotation.
(foo = 'FOO') => {}
// Message: Missing "foo" parameter type annotation.
(...foo) => {}
// Message: Missing "foo" parameter type annotation.
({foo}) => {}
// Message: Missing "{foo}" parameter type annotation.
The following patterns are not considered problems:
(foo: string) => {}
(foo: string = 'FOO') => {}
(...foo: string) => {}
({foo}: {foo: string}) => {}
require-return-typeRequires that functions have return type annotation.
The following patterns are considered problems:
(foo) => {}
// Message: Missing return type annotation.
The following patterns are not considered problems:
(foo): string => {}
space-after-type-colonEnforces consistent spacing after the type annotation colon.
This rule takes one argument. If it is 'always' then a problem is raised when there is no space after the type annotation colon. If it is 'never' then a problem is raised when there is a space after the type annotation colon. The default value is 'always'.
The following patterns are considered problems:
// Options: ["never"]
(foo: string) => {}
// Message: There must be no space after "foo" parameter type annotation colon.
// Options: ["always"]
(foo:string) => {}
// Message: There must be a space after "foo" parameter type annotation colon.
// Options: ["always"]
(foo: string) => {}
// Message: There must be 1 space after "foo" parameter type annotation colon.
The following patterns are not considered problems:
(foo) => {}
(foo: string) => {}
// Options: ["never"]
(foo:string) => {}
// Options: ["always"]
(foo: string) => {}
space-before-type-colonEnforces consistent spacing before the type annotation colon.
This rule takes one argument. If it is 'always' then a problem is raised when there is no space before the type annotation colon. If it is 'never' then a problem is raised when there is a space before the type annotation colon. The default value is 'never'.
The following patterns are considered problems:
// Options: ["never"]
(foo : string) => {}
// Message: There must be no space before "foo" parameter type annotation colon.
// Options: ["always"]
(foo: string) => {}
// Message: There must be a space before "foo" parameter type annotation colon.
// Options: ["always"]
(foo : string) => {}
// Message: There must be 1 space before "foo" parameter type annotation colon.
The following patterns are not considered problems:
(foo) => {}
(foo: string) => {}
// Options: ["never"]
(foo: string) => {}
// Options: ["always"]
(foo : string) => {}
eslint-plugin-flowtype v1eslint-plugin-flowtype v1 served a different purpose:
A plugin for ESLint that strips FlowType type annonations before linting the files.
You can find the source code for v1 at:
https://github.com/gcazaciuc/eslint-plugin-flowtype
Reference to the original codebase included for historical reference purposes.
FAQs
Flowtype linting rules for ESLint.
The npm package eslint-plugin-flowtype receives a total of 3,765,190 weekly downloads. As such, eslint-plugin-flowtype popularity was classified as popular.
We found that eslint-plugin-flowtype demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.