facebook / facebook/flow

[libdef] declare module auto-export is too much magic

未关闭
#3,119 3 条评论 3 个 reaction 已指派 0 人 在 GitHub 查看
declarations
主要语言
Rust
星标
22.3k
派生
1.9k
PR 合并指标
30 天内没有已合并 PR

描述

I see this all the time... people (including me initially) are really confused about the export handling of `declare module`.

If I do this:

```
declare module 'mylib' {
declare type Foo = { bar: 'test' };
}
```

The type `Foo` will automatically be exported.
As soon as I use `declare module.exports: ...`, `declare var exports: ...` or `export type Other = ....`, flow will only export entities via the export mechanics.

IMO it should by default assume private scope and only export entities, which are explicitly exported (like ES6 or Node CJS do).

It causes a lot of confusion whenever someone submits `flow-typed` libdefs... people tend to use namespaces inside `declare module`, although they are using `declare module.exports` and just make libdefs hard to read (because of this `$npm$whatever$MyType` naming).

I wonder if the default behavior will be changed in the future?

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。