WIP: Typing HOCs with recompose

It's hard to keep prop types of underlying components of HOCs. Even the official documentation is not working well. It's even harder to have multiple HOCs typed and maintain with peer developers. Here comes recompose, the HOC utility module. If we have recompose properly typed, we can omit typing of our own HOCs taking advantage of recompose and flowtype's type inference.

recompose still doesn't have official flowtype definition, but there are some efforts:

• https://github.com/acdlite/recompose/pull/241
• https://github.com/flowtype/flow-typed/pull/624

This gist is an effort to make it happen based on the PRs above.

Goals

• Keep types of underlying component's props
• Allow underlying component to ignore additional props by HOC
• No additional type annotations on top of recompose

Implementation details

• In a union type, a specific type should come before more general types.
  • NG: T | Fn1<A, B>
  • OK: Fn1<A, B> | T
• HOCs that provide additional props may return HOC<$Shape<A & B>, B>. In this way, the underlying component can ignore some unnecessary intermediate props.
  • For example:

    1const withOpen = withValue(false, (open, setOpen) => ({ open, setOpen }));
    2const withToggle = withProps(({ open, setOpen }) => ({ toggle: () => setOpen(!open) }));
    3
    4// `Something` doesn't need `setOpen`!
    5function Something({ open, toggle }) { /* ... */ }
    6const enhancedSomething = compose(withOpen, withToggle)(Something);

• suppress_comment suppresses also next next line in addition to next line. So put a new line after the suppression target line.

  • For example:

    // .flowconfig
    [options]
    suppress_comment=^ $ExpectError$
    // or
    suppress_comment=\\(.\\|\n\\)*\\$ExpectError
    

    1// $ExpectError
    2'foo'.bar();
    3'foo'.bar(); // This line's error is also suppressed!
    4
    5// $ExpectError
    6'foo'.bar();
    7
    8'foo'.bar(); // This line's error is not suppressed!

Reference

• facebook/flow src/typing/type_annotation.ml
• facebook/flow lib/react.js
• Flow type cheat sheet
• Secret Flow Types
• Generic React HOC
• flowtypeのUtility Typeについて その1 (Japanese)
• flowtypeのUtility Typeについて その2 (Japanese)