Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nwaywood/neutrino-preset-flow

Neutrino preset for flow
https://github.com/nwaywood/neutrino-preset-flow

flow neutrino neutrino-preset

Last synced: 1 day ago
JSON representation

Neutrino preset for flow

Awesome Lists containing this project

README

        

# Neutrino flow preset

[![NPM version][npm-image]][npm-url]

`neutrino-preset-flow` is a Neutrino preset that adds support for
[flow][flow-url]

## Requirements

- Node.js v7+
- Yarn or npm client
- Neutrino v8, Neutrino build preset

## Installation

`neutrino-preset-flow` can be installed via the Yarn or npm clients.

### Yarn

```bash
yarn add neutrino-preset-flow
```

### npm

```bash
npm install --save neutrino-preset-flow
```

## Usage

Add `neutrino-preset-flow` to `use` in your `.neutrinorc.js`.

```js
module.exports = {
use: [
'@neutrinojs/eslint',
'neutrino-preset-react',
'neutrino-preset-flow',
...
]
};
```

and then create the `.flowconfig` file at the root of your project.

Note: Both `neutrino-preset-react` and `eslint` are required dependencies (`eslint` can be installed using any neutrino plugin that includes it, `@neutrinojs/eslint`, `neutrino-preset-prettier-eslint` etc...)

```
touch .flowconfig
```

And that's all. For `flow` specific usage, see their [docs][flow-url].
For Neutrino usage, refer to their [documentation][neutrino-docs].

[npm-image]: https://img.shields.io/npm/v/neutrino-preset-flow.svg
[npm-url]: https://npmjs.org/package/neutrino-preset-flow
[flow-url]: https://flow.org/
[neutrino-docs]: https://neutrino.js.org/