Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rspack-contrib/rsbuild-plugin-node-polyfill
An Rsbuild plugin to automatically inject polyfills for Node.js builtin modules into the browser side.
https://github.com/rspack-contrib/rsbuild-plugin-node-polyfill
rsbuild rsbuild-plugin rspack
Last synced: about 1 month ago
JSON representation
An Rsbuild plugin to automatically inject polyfills for Node.js builtin modules into the browser side.
- Host: GitHub
- URL: https://github.com/rspack-contrib/rsbuild-plugin-node-polyfill
- Owner: rspack-contrib
- License: mit
- Created: 2024-07-02T06:52:16.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-01T01:48:58.000Z (about 1 month ago)
- Last Synced: 2024-12-01T02:31:53.240Z (about 1 month ago)
- Topics: rsbuild, rsbuild-plugin, rspack
- Language: TypeScript
- Homepage:
- Size: 225 KB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rspack - @rsbuild/plugin-node-polyfill
README
# @rsbuild/plugin-node-polyfill
An Rsbuild plugin to automatically inject polyfills for [Node.js builtin modules](https://nodejs.org/api/modules.html#built-in-modules) into the browser side.
## When to use
Normally, we don't need to use Node builtin modules on the browser side. However, it is possible to use some Node builtin modules when the code will run on both the Node side and the browser side, and this plugin provides browser versions of polyfills for these Node builtin modules.
By using the Node Polyfill plugin, polyfills for Node builtin modules are automatically injected into the browser-side, allowing you to use these modules on the browser side with confidence.
## Usage
Install:
```bash
npm add @rsbuild/plugin-node-polyfill -D
```
Add plugin to your `rsbuild.config.ts`:
```ts
// rsbuild.config.ts
import { pluginNodePolyfill } from '@rsbuild/plugin-node-polyfill'
export default {
plugins: [pluginNodePolyfill()],
}
```
## Node Polyfills
### Globals
- `Buffer`
- `process`
When you use the above global variables in your code, the corresponding polyfill will be automatically injected.
For instance, the following code would inject the `Buffer` polyfill:
```ts
const bufferData = Buffer.from('abc')
```
You can disable this behavior through the `globals` option of the plugin:
```ts
pluginNodePolyfill({
globals: {
Buffer: false,
process: false,
},
})
```
### Modules
- `assert`
- `buffer`
- `console`
- `constants`
- `crypto`
- `domain`
- `events`
- `http`
- `https`
- `os`
- `path`
- `punycode`
- `process`
- `querystring`
- `stream`
- `_stream_duplex`
- `_stream_passthrough`
- `_stream_readable`
- `_stream_transform`
- `_stream_writable`
- `string_decoder`
- `sys`
- `timers`
- `tty`
- `url`
- `util`
- `vm`
- `zlib`
When the above module is referenced in code via import / require syntax, the corresponding polyfill will be injected.
```ts
import { Buffer } from 'buffer'
const bufferData = Buffer.from('abc')
```
### Fallbacks
- `child_process`
- `cluster`
- `dgram`
- `dns`
- `fs`
- `module`
- `net`
- `readline`
- `repl`
- `tls`
Currently there is no polyfill for the above modules on the browser side, so when you import the above modules, it will automatically fallback to an empty object.
```ts
import fs from 'fs'
console.log(fs) // -> {}
```
## Options
### globals
Used to specify whether to inject polyfills for global variables.
- **Type:**
```ts
type Globals = {
process?: boolean
Buffer?: boolean
}
```
- **Default:**
```ts
const defaultGlobals = {
Buffer: true,
process: true,
}
```
### protocolImports
Whether to polyfill Node.js builtin modules starting with `node:`.
- **Type:** `boolean`
- **Default:** `true`
For example, if you disable `protocolImports`, modules such as `node:path`, `node:http`, etc. will not be polyfilled.
```ts
pluginNodePolyfill({
protocolImports: false,
})
```
### include
Specify an array of modules for which polyfills should be injected. If this option is set, only the specified modules will be polyfilled. `include` is mutually exclusive with [`exclude`](#exclude).
- **Type:** `string[]`
- **Default:** `undefined`
```ts
pluginNodePolyfill({
include: ['buffer', 'crypto'], // Only "buffer" and "crypto" modules will be polyfilled.
})
```
### exclude
Specify an array of modules for which polyfills should not be injected from the default. If this option is set, the specified modules will be excluded from polyfilled. `exclude` is mutually exclusive with [`include`](#include).
- **Type:** `string[]`
- **Default:** `undefined`
```ts
pluginNodePolyfill({
exclude: ['http', 'https'], // All modules except "http" and "https" will be polyfilled.
})
```
### overrides
Override the default polyfills for specific modules.
- **Type:** `Record`
- **Default:** `{}`
```ts
pluginNodePolyfill({
overrides: {
fs: 'memfs',
},
})
```
## Exported variables
- `builtinMappingResolved`: A map of Node.js builtin modules to their resolved corresponding polyfills modules.
- `resolvedPolyfillToModules`: A map of resolved polyfill modules to the polyfill modules before resolving.
## License
[MIT](./LICENSE).