ts-to-flow

Convert Typescript types to Flow

Install

yarn add --dev @telefonica/ts-to-flow

Usage

yarn ts-to-flow <.d.ts-path> [copy-path] [overrides-path]

Examples

yarn ts-to-flow "dist"

dist is the directory (relative to the package root) where the .d.ts files are located. It will generate the corresponding .js.flow files in the same location.

You can optionally pass a second path argument:

yarn ts-to-flow "dist" "flow-types"

Where flow-types is a directory (relative to the package root) where the generated .js.flow files will be copied. You can commit this directory in your package so you can see type changes in code reviews.

Additionally if you execute this command in a CI environment, it will throw if this command produces new changes.

yarn ts-to-flow "dist" "flow-types" "flow-overrides"

Same as before, but after generating and copying the flow-types, copies the contents of flow-overrides folder into dist and flow-types. This way you can write custom type definitions for some files.

Local Development

Below is a list of commands you will probably find useful.

yarn build

Bundles the package to the dist folder. The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module).

yarn test

Runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.