https://github.com/aduth/esbuild-esm-loader
ESM loader to transform imports using ESBuild
https://github.com/aduth/esbuild-esm-loader
Last synced: about 1 year ago
JSON representation
ESM loader to transform imports using ESBuild
- Host: GitHub
- URL: https://github.com/aduth/esbuild-esm-loader
- Owner: aduth
- License: mit
- Created: 2021-03-13T15:06:24.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-02T19:07:03.000Z (over 1 year ago)
- Last Synced: 2025-03-13T22:35:06.365Z (over 1 year ago)
- Language: JavaScript
- Size: 773 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ESBuild ESM Loader
**ESBuild ESM Loader** is a custom resolver implementation for the [module customization hooks](https://nodejs.org/docs/latest/api/module.html#customization-hooks) feature of Node.js ECMAScript modules.
Using this loader will enhance the default loader behavior to allow you to transform imported files using [ESBuild](https://esbuild.github.io/), allowing for transparent imports of modern JavaScript, JSX, and TypeScript.
```tsx
// index.tsx
import React from 'react';
import { renderToStaticMarkup } from 'react-dom/server';
console.log(renderToStaticMarkup(
Hello World!));
```
```
node --import=esbuild-esm-loader/register ./index.tsx
```
## Installation
The current version of the library requires **Node.js v16.17 or newer**.
Install as a dependency using `npm`. You will also need to install ESBuild, as it's a peer dependency of this project.
```
npm install esbuild esbuild-esm-loader
```
## Usage
Loaders can be defined as an argument when running `node`.
```
node --import=esbuild-esm-loader/register entry.js
```
For better error stack traces, this loader supports [Node.js's native sourcemap support](https://nodejs.org/api/module.html#source-map-v3-support), which can be enabled by passing the `--enable-source-maps` flag.
```
node --enable-source-maps --import=esbuild-esm-loader/register entry.js
```
## Configuration
If present, a `tsconfig.json` will be read and provided to ESBuild as the [`tsconfigRaw` option](https://esbuild.github.io/api/#tsconfig-raw). You can use this to control behavior such as JSX pragma with TypeScript's [`jsxFactory` configuration option](https://www.typescriptlang.org/tsconfig#jsxFactory). This applies even if you are not using TypeScript.
## Versioning
This project follows [Semantic Versioning](https://semver.org/).
To better align with the experimental status of the loader hooks, initial releases will follow major version zero until the feature stabilizes in Node.js. Minor versions on the zero major will always include breaking changes. Patch versions on the zero major will include bug fixes and backwards-compatible changes.
Versioning will proceed from 1.0.0 once the feature stabilizes in Node.js.
## License
Copyright 2025 Andrew Duthie
Released under the MIT License. See [LICENSE.md](./LICENSE.md).