gajus/eslint-plugin-flowtype

Rule for requiring types for fn definitions only

Open

#91 opened on Aug 27, 2016

View on GitHub
 (11 comments) (0 reactions) (0 assignees)JavaScript (1,078 stars) (167 forks)batch import
help wanted

Description

One of Flow's goals was to provide an 'incremental' model, where users could incrementally migrate their code. As a user of this module, I have faced an overwhelming number of issues with the current "flowtype/require-parameter-type" rule, which throws an error on every missing declaration. A rule that would complement flow's goal of 'incremental migration' would be a separate rule for requiring types for function definitions.

Ideally, it would do something like this:

function example(number) {  // <-- require types here
  return new Promise((resolve, reject) => { 
    resolve(someArray.map(each => each)) // <-- DO NOT require types here
  })
}

Contributor guide

Tech stack
javascript
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ESLint plugin developmentFlow type systemAST manipulation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review the existing require parameter type rule implementation (likely in src/rules/require parameter type.js) and the function definition AST nodes from Flow's AST. Look at how the rule collects parameter types from function declarations vs function expressions. Consider creating a new rule file require return type or modifying the current rule to have an option for function definitions only. The issue has comments discussing the approach; read through them for additional context.
Rule for requiring types for fn definitions only · gajus/eslint-plugin-flowtype#91 | Good First Issue