facebook / facebook/flow

[Feature request] Allow type imports in module declaration files from user land files

Open
#3,122 1 comment 0 reactions 0 assignees View on GitHub
feature request
Dominant language
Rust
Stars
22.3k
Forks
1.9k
PR merge metrics
No merged PRs in 30d

Description

I would like to propose the ability to import types from user land(eg project files) into module declarations files(eg files living in flow-typed directory) the benefit being potentially shaving of redundant declarations from tens/hundreds of files.

The reasoning behind why this is extremely useful is inspired by some actual use cases in the projects I work on:

Suppose a typical React-Redux app that contains interfaces for Redux and Reselect libraries. The shape of a container in redux would be something like
```js
function mapStateToProps(state, props)
```
and for a reselect selector
```js
selector(state)
```
In both cases the state has always the same shape, eg `AppStateType`.
In order to properly type these functions currently you need to add type annotations in all the selectors and containers in the app specifying that `state` is of type `AppStateType`.

This is redundant and it creates boilerplate.

If such type imports from user land code into module declarations files would be permitted one could adjust both the local Redux and Reselect module declarations and type the `state` param of the containers and selectors as AppStateType once potentially shaving off the need to redeclare the state as being an `AppStateType` from hundreds of places in the app.

cc @jeffmo

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.