https://github.com/ilyalesik/gen-flow-files

Script for transform javascript files to flowtype definition files
https://github.com/ilyalesik/gen-flow-files

flow flowtype

Last synced: about 1 month ago
JSON representation

Script for transform javascript files to flowtype definition files

• Host: GitHub
• URL: https://github.com/ilyalesik/gen-flow-files
• Owner: ilyalesik
• Created: 2019-01-16T12:00:44.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-01-27T17:02:43.000Z (over 2 years ago)
• Last Synced: 2024-05-09T05:19:48.200Z (about 2 months ago)
• Topics: flow, flowtype
• Language: JavaScript
• Homepage:
• Size: 269 KB
• Stars: 28
• Watchers: 5
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Lists

• awesome-flow - gen-flow-files - Script for transform JavaScript files to flow definition files. (Tools)

README

        
# gen-flow-files

[![npm version](https://img.shields.io/npm/v/gen-flow-files.svg)](https://www.npmjs.com/package/gen-flow-files)

[![npm downloads](https://img.shields.io/npm/dt/gen-flow-files.svg)](https://www.npmjs.com/package/gen-flow-files)

This is a script which finds `.js` files with @flow annotation, extract flow definitions and save to specific folder.

As example, `/example.js`

```javascript

// @flow

extract function foo(arg1: number, arg2: string): string {

    // some code here

}

```

will be transformed to `/example.js.flow`:

```javascript

// @flow

declare extract function foo(arg1: number, arg2: string): string;

```

## Installation

Install it with yarn:

```

yarn add gen-flow-files

```

Or with npm:

```

npm i gen-flow-files --save

```

## Usage

#### As part of build process

```json

scripts": {

    ...

    "flow": "flow",

    "build:flow": "gen-flow-files src --out-dir dist",

    ...

  },

```

transfrom all *.js* files from `src` to *.js.flow* files and save them at `dist`. 

#### As command

```

npx gen-flow-files  --out-dir 

```

transfrom all *.js* files from `` to *.js.flow* files and save them at ``.