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.