@sasho/flow-to-ts
[![Actions Status](https://github.com/Khan/flow-to-ts/workflows/Node%20CI/badge.svg)](https://github.com/Khan/flow-to-ts/actions) [![codecov](https://codecov.io/gh/Khan/flow-to-ts/branch/master/graph/badge.svg)](https://codecov.io/gh/Khan/flow-to-ts)
Last updated 3 months ago by sasho .
MIT · Repository · Original npm · Tarball · package.json
$ cnpm install @sasho/flow-to-ts 
SYNC missed versions from official npm registry.

flow-to-ts

Actions Status codecov

Convert Flow code to TypeScript.

The goal of this project is to provide a tool that can translate 95% of Flow to TypeScript while maintaining a high percentage of the existing type information. We don't want to convert code and end up with everything using any. We also want to avoid having to make a lot of manual changes to files afterwards, e.g. changing SyntheticEvent to React.Event.

Quick start

  • yarn global add @khanacademy/flow-to-ts
  • flow-to-ts [options] <file globs>

Playground

https://flow-to-ts.netlify.com

Principles

  • when exact translation isn't possible:
    • downgrade to any when possible and provide a gentle warning
    • when it isn't possible to downgrade (e.g. %checks), remove the syntax and provide a forceful warning that the code in question will need a human to convert it manually.
  • best effort to maintain blank lines and the position comments, this isn't always possible so warn in those situations where we can't, e.g. converting object type spreads to intersection types.

Contibuting

Bugs

Bug reports for converting Flow to TypeScript should include a link to the playground with an example of a minimal reproducible example of the bug.

Feature Requests

Feature requests are welcome.

Pull Requests

Please make sure there is a GitHub issue first before creating a pull request except for small things. Also, please sign our Contributor License Agreement.

Pull requests that fix a bug in the conversion code should include one or more test cases and should have 100% diff coverage.

Dev quick start

git clone git@github.com:Khan/flow-to-ts.git
cd flow-to-ts
yarn
yarn test

Helpful resources

Current Tags

  • 0.1.8                                ...           latest (3 months ago)

3 Versions

  • 0.1.8                                ...           3 months ago
  • 0.1.7                                ...           3 months ago
  • 0.1.6                                ...           3 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 3
Dev Dependencies (11)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |