https://github.com/freckle/gen-flow-js
https://github.com/freckle/gen-flow-js
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/freckle/gen-flow-js
- Owner: freckle
- License: mit
- Created: 2023-03-11T01:36:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-03T22:02:22.000Z (about 3 years ago)
- Last Synced: 2024-04-14T00:01:07.547Z (about 2 years ago)
- Language: TypeScript
- Size: 975 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @freckle/gen-flow
Generate Flow type interfaces from TypeScript interfaces.
## Install
```sh
yarn add -D @freckle/gen-flow
```
## Usage
Generate Flow interfaces given a path containing TypeScript interfaces (`.d.ts`
files). The Flow interfaces will be adjacent to the TypeScript interfaces.
```sh
> ls dist/
index.d.ts index.js
> yarn run gen-flow dist
> ls dist/
index.d.ts index.js index.js.flow
```
This can be used as part of a build process in a project:
```json
{
"name": "my-package",
"scripts": {
"build": "yarn clean && tsc -d && yarn gen-flow",
"gen-flow": "gen-flow dist",
"clean": "rm -r -f dist/""
}
}
```
## Versioning and release process##
See [RELEASE.md](./RELEASE.md)
---
[LICENSE](./LICENSE)