facebook / flow

Adds static typing to JavaScript to improve developer productivity and code quality.
https://flow.org/
MIT License
22.1k stars 1.86k forks source link

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

Open gcazaciuc opened 7 years ago

gcazaciuc commented 7 years ago

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

function mapStateToProps(state, props)

and for a reselect selector

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

kumar303 commented 7 years ago

If you use type aliases and put them in your program code (not in flow-typed include files) then you can solve this. Example:

// In app/ducks.js:
export type AppStateType = {
  foo: string,
};
// In app/component.js:
import type { AppStateType } from 'app/ducks.js';

function mapStateToProps(state: AppStateType, props) {
}