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

https://github.com/calebdwilliams/esbuild-plugin-import-assertions

A plugin for esbuild to enable import assertions
https://github.com/calebdwilliams/esbuild-plugin-import-assertions

Last synced: 8 months ago
JSON representation

A plugin for esbuild to enable import assertions

Awesome Lists containing this project

README

          

# esbuild-plugin-import-assertions

The `esbuild-plugin-import-assertions` plugin [import assertion behavior](https://github.com/tc39/proposal-import-assertions) for esbuild.

## Installation

This package is available on npm under the name esbuild-plugin-import-assertions and can be installed with npm, yarn or however else you consume dependencies.

### Example commands:

#### npm:
```zsh
npm i esbuild-plugin-import-assertions
```

#### yarn:
```zsh
yarn add esbuild-plugin-import-assertions
```

## Usage

To use the plugin you [must use the JavaScript API for running esbuild](https://github.com/evanw/esbuild/issues/884#issuecomment-786163584). An example configuration is below

```javascript
import { importAssertPlugin } from 'esbuild-plugin-import-assertions';
import { build } from 'esbuild';

build({
entryPoints: ['./app.ts'],
bundle: true,
outfile: './lib/out.js',
plugins: [importAssertPlugin],
target: ['chrome100']
}).catch(() => process.exit(1))
```

A current limitation of the plugin is that you must set esbuild's `bundle` option to `true`. Likewise, asynchronous imports are not currently supported.