https://github.com/flow/flow-bin

Binary wrapper for Flow - A static type checker for JavaScript
https://github.com/flow/flow-bin

Last synced: 1 day ago
JSON representation

Binary wrapper for Flow - A static type checker for JavaScript

• Host: GitHub
• URL: https://github.com/flow/flow-bin
• Owner: flow
• License: other
• Created: 2014-11-18T21:56:06.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T18:24:01.000Z (about 2 months ago)
• Last Synced: 2024-10-29T20:29:22.862Z (about 2 months ago)
• Language: Makefile
• Homepage: https://flow.org
• Size: 329 KB
• Stars: 536
• Watchers: 21
• Forks: 48
• Open Issues: 6
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-starred-test - flow/flow-bin - Binary wrapper for Flow - A static type checker for JavaScript (Makefile)

README

        
# flow-bin

> Binary wrapper for [Flow](https://flow.org) - A static type checker for JavaScript

macOS (x64), Linux (x64, arm64) and Windows (x64) binaries are currently [provided](https://flow.org/en/docs/install/).

## CLI

For Yarn:

```

$ yarn add --dev flow-bin

$ yarn run flow --help

```

For npm, add `{ "scripts": { "flow": "flow" } }` in package.json and run:

```

$ npm install --save-dev flow-bin

$ npm run flow --help

```

## API

```

$ npm install --save flow-bin

```

```js

const execFile = require('child_process').execFile;

const flow = require('flow-bin');

execFile(flow, ['check'], (err, stdout) => {

	console.log(stdout);

});

```

## License

flow-bin is MIT-licensed.

## Releases

### New Release

1. `make push VERSION=0.122.0` (use the same version as Flow)

2. Publish to npm: `make publish` (run `npm adduser` the first time to log in)

### Inspect a Release Before Publishing

```sh

npm pack

tar xf "flow-bin-$(node -p 'require("./package.json").version').tgz"

cd package

npm run verify

```