https://github.com/bunchtogether/vite-plugin-flow

https://github.com/bunchtogether/vite-plugin-flow

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/bunchtogether/vite-plugin-flow
• Owner: bunchtogether
• License: apache-2.0
• Created: 2021-06-16T19:25:35.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-16T20:09:31.000Z (almost 3 years ago)
• Last Synced: 2024-11-05T18:06:42.032Z (3 months ago)
• Language: JavaScript
• Size: 140 KB
• Stars: 22
• Watchers: 2
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-repos - bunchtogether/vite-plugin-flow - (JavaScript)

README

        
# vite-plugin-flow

Support [Flow static type checking](https://flow.org/) in [Vite](https://vitejs.dev/)

## Install

```shell

npm install @bunchtogether/vite-plugin-flow --save-dev

```

or

```shell

yarn add @bunchtogether/vite-plugin-flow --dev

```

## Usage

```js

import { flowPlugin, esbuildFlowPlugin } from '@bunchtogether/vite-plugin-flow';

export default {

  optimizeDeps: {

    esbuildOptions: {

      plugins: [esbuildFlowPlugin()]

    }

  },

  plugins: [

    flowPlugin()

  ]

}

```

## API

#### Table of Contents

*   [flowPlugin](#flowplugin)

    *   [Parameters](#parameters)

*   [esbuildFlowPlugin](#esbuildflowplugin)

    *   [Parameters](#parameters-1)

### flowPlugin

Create a Vite plugin object

#### Parameters

*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Filter options (optional, default `{include:/\.(flow|jsx?)$/,exclude:/node_modules/,flow:{all:false,pretty:false,ignoreUninitializedFields:false}}`)

    *   `options.include` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Regexp](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Regexp](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp))>)** Strings and/or regular expressions matching file paths to include (optional, default `/\.(flow|jsx?)$/`)

    *   `options.exclude` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Regexp](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Regexp](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp))>)** Strings and/or regular expressions matching file paths to exclude (optional, default `/node_modules/`)

Returns **VitePlugin** Returns esbuild plugin object

### esbuildFlowPlugin

*   **See**: [esbuild plugins documentation](https://esbuild.github.io/plugins/#resolve-callbacks)

Create an esbuild plugin object

#### Parameters

*   `filter` **[RegExp](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp)** Regular expression matching the path a files to be processed (optional, default `/\.(flow|jsx?)$/`)

*   `loaderFunction` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Function that accepts the file path and returns the esbuild loader type (optional, default `(path)=>(/\.jsx$/.test(path)?'jsx':'js')`)

*   `flowOptions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options to pass to flow-remove-types (optional, default `{all:false,pretty:false,ignoreUninitializedFields:false}`)

    *   `flowOptions.all` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If true, bypasses looking for an @flow pragma comment before parsing. (optional, default `false`)

    *   `flowOptions.pretty` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If true, removes types completely rather than replacing with spaces. (optional, default `false`)

    *   `flowOptions.ignoreUninitializedFields` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** If true, removes uninitialized class fields (`foo;`, `foo: string;`)

        completely rather than only removing the type. THIS IS NOT SPEC

        COMPLIANT! Instead, use `declare foo: string;` for type-only fields. (optional, default `false`)

Returns **EsbuildPlugin** Returns esbuild plugin object