gajus/eslint-plugin-flowtype

Rule for requiring types for fn definitions only

Open

#91 建立於 2016年8月27日

在 GitHub 查看
 (11 留言) (0 反應) (0 負責人)JavaScript (1,078 star) (167 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.