gajus/eslint-plugin-flowtype

Rule for requiring types for fn definitions only

Open

#91 opened on 2016年8月27日

GitHub で見る
 (11 comments) (0 reactions) (0 assignees)JavaScript (1,078 stars) (167 forks)batch import
help wanted

説明

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
  })
}

コントリビューターガイド

技術スタック
javascript
領域
tooling
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
ESLint plugin developmentFlow type systemAST manipulation
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
40
調査方針
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.