# reasonable-flowgen

> Generate flowtype definition files from TypeScript

Latest version **0.1.5** (published 2017-09-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install reasonable-flowgen
pnpm add reasonable-flowgen
yarn add reasonable-flowgen
bun add reasonable-flowgen
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2017-09-04 |
| First published | 2017-08-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+10 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | rrdelaney |

## Links

- npm: https://www.npmjs.com/package/reasonable-flowgen
- npm.io page: https://npm.io/package/reasonable-flowgen

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) 4.9.0
- [typescript](https://npm.io/package/typescript.md) 2.1.4
- [typescript-compiler](https://npm.io/package/typescript-compiler.md) ^1.4.1-2

## Recent versions

- 0.1.5 (latest) — 2017-09-04
- 0.1.4 — 2017-09-04
- 0.1.3 — 2017-08-26
- 0.1.2 — 2017-08-26
- 0.1.0 — 2017-08-23

## README

# reasonable-flowgen

> A fork of the original [flowgen](https://github.com/joarwilk/flowgen) customized for [ReasonablyTyped](https://github.com/rrdelaney/ReasonablyTyped)

## Usage

Install using `npm i reasonable-flowgen --save`

```js
import compiler from 'flowgen';

// To compile a d.ts file
const flowdef = compiler.compileDefinitionFile(filename);

// To compile a string
const flowdef = compiler.compileDefinitionString(str);

// To compile a typescript test file to JavaScript
// esTarget = ES5/ES6 etc
const testCase = compiler.compileTest(path, esTarget)
```

## The difficult parts

### Namespaces
Namespaces have been a big headache. What it does right now is that it splits any namespace out into prefixed global scope declarations instead. It works OK, but its not pretty and there's some drawbacks to it.

### External library imports
Definitions in TS and flow are often quite different, and imported types from other libraries dont usually have
a one-to-one mapping. Common cases are `React.ReactElement`, `React.CSSProps`etc.
This might require manual processing, or we add a set of hardcoded mutations that handle common cases.

### Odd TS conventions
[Lodash](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/lodash/index.d.ts) has been one of the reference libraries i've worked with when creating the
converter. The definition is mostly just a series of interfaces with the same name being re-declared over and over again for each function, which doesn't translate to flow at all. There's multiple ways of solving this but I dont have a great solution for it in place yet.

## Contributing

All help is appreciated. Please [tweet at me](https://twitter.com/joarwilk) if you want some help getting started, or just want to discuss ideas on how to solve the trickier parts.

---
_Source: https://npm.io/package/reasonable-flowgen · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._