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

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

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/radex/flow-bin
• Owner: radex
• License: other
• Created: 2021-03-16T14:56:33.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-16T14:57:09.000Z (almost 4 years ago)
• Last Synced: 2024-11-23T14:48:25.590Z (about 2 months ago)
• Language: JavaScript
• Size: 27.8 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# flow-bin [![Build Status](https://travis-ci.org/flowtype/flow-bin.svg?branch=master)](https://travis-ci.org/flowtype/flow-bin)

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

OS X, Linux (64-bit) and Windows 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

```