flowtype - npm 模块如何开箱即用地提供自己的 Flow libdef？

Question

我已经编写了一个带有 Flow 类型注释的 npm 模块。它的 .flowconfig 文件包含 unsafe.enable_getters_and_setters=true 因为它在内部使用了 getter 和 setter。

但问题是任何依赖我的模块(并自己使用 Flow)的人都需要设置相同的选项以避免 Flow 在类型检查时提示 我的 模块 他们的项目。

我想做的(也是我希望的)是提供一个开箱即用的 libdef 文件，并让它优先于我的源代码，所以任何依赖的 Flow 只会查看我的 libdef，不会查看我的代码并提示使用 getters/setters。

谁能解释一下如何做到这一点？我的猜测是，我应该创建一个与任何 .js 文件相对应的 .js.flow 文件，并将其与我的模块一起发布，然后这将需要优先级并防止 Flow 查看原始 .js 文件。 (也许甚至应该可以自动生成我的 .js.flow libdef 文件..？)但我找不到这方面的任何信息。

文档站点很棒，但它似乎没有解释如何执行此操作。单例mention .js.flow 文件扩展名是指向 JS alert('TODO') :)

的链接

Answer 1

您可以输入您的包并在此处发布它们:https://github.com/flowtype/flow-typed .使用流类型化工具，您可以为您的包生成一个完整的 stub ，然后填写类型。

或者，如果您的包的主程序是 index.js 并包含所有导出 - 您可以创建一个 index.js.flow 并为所有导出定义类型那里。