https://github.com/dalcib/esbuild-plugin-flow

Esbuild plugin to strip types for Flow files
https://github.com/dalcib/esbuild-plugin-flow

Last synced: about 2 months ago
JSON representation

Esbuild plugin to strip types for Flow files

• Host: GitHub
• URL: https://github.com/dalcib/esbuild-plugin-flow
• Owner: dalcib
• License: mit
• Created: 2020-11-06T08:54:33.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-12-29T21:04:15.000Z (about 3 years ago)
• Last Synced: 2024-11-30T15:07:00.099Z (2 months ago)
• Language: JavaScript
• Size: 13.7 KB
• Stars: 16
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-esbuild - esbuild-plugin-flow - remove-types package. (Plugins)

README

        
# esbuild-plugin-flow

Esbuild plugin to strip types for Flow files using [flow-remove-types](https://www.npmjs.com/package/flow-remove-types)

## Installation

```

npm i --dev https://github.com/dalcib/esbuild-plugin-flow

```

## Usage

The esbuild [plugin API](https://esbuild.github.io/plugins/) isn't supported via CLI, so use a custom build script like so:

```js

const esbuild = require('esbuild')

const flow = require('esbuild-plugin-flow')

esbuild

  .build({

    entryPoints: ['index.js'],

    outfile: 'dist/bundle.js',

    bundle: true,

    plugins: [flow(/\.flow\.jsx?$/)],

  })

  .catch(() => process.exit(1))

```

## Options

The plugin has to parameters: `regexp` and `[force]`

### regexp

The plugin needs a RegExp to define:

#### a) paths or packages to be included

```javascript

;/node_modules\\package.*\.jsx?$/

```

#### b) extentions

```javascript

;/\.flow\.jsx?$/

```

#### c) a combination of both

```javascript

;/node_modules\\package1.*\.jsx?$|node_modules\\package2.*\.jsx?$|\.flow\.jsx?$/

```

### force [optional]

A Boolean indicating that the plugin must act regardless of the existence of flow annotations (`// @flow` or `/** @flow /*`) in the file.

## Entry Point

Due to limitations of Esbuild, the entry point is not processed.

## Tests

For test, copy the folder `flow-pkg` to node_modules and run `node tests/test`