grikomsn / vite-plugin-ngmi-polyfill Goto Github PK

View Code? Open in Web Editor NEW

9.0 0.0 5.0 74 KB

Vite plugin for polyfilling Node.js built-in globals and modules ⚡️

Home Page: https://www.npmjs.com/package/vite-plugin-ngmi-polyfill

License: MIT License

Shell 1.86% JavaScript 34.25% TypeScript 63.90%

polyfill vite vite-plugin vite-plugin-ngmi vite-plugin-ngmi-polyfill

vite-plugin-ngmi-polyfill's Introduction

vite-plugin-ngmi-polyfill

Vite plugin for polyfilling Node.js built-in globals and modules ⚡️

Table of contents

Reason
Installing
Usage
Examples
Included packages
License

Reason

Some modules such as events or process requires polyfilling since Vite does not handle it by default (here's a search for vite browser-external errors), whereas several packages, especially web3 related ones, use these packages in order to work.

This package wraps other polyfill packages and exports a Vite plugin so you can easily import inside your vite.config.{js,ts}.

Installing

# using npm
npm install vite vite-plugin-ngmi-polyfill

# using yarn
yarn add vite vite-plugin-ngmi-polyfill

# using pnpm
pnpm add vite vite-plugin-ngmi-polyfill

Usage

import { defineConfig } from "vite";
import { NgmiPolyfill } from "vite-plugin-ngmi-polyfill";

export default defineConfig({
  plugins: [NgmiPolyfill()],
});

Examples

https://github.com/strangelove-ventures/graz-vite-example

Included packages

License

vite-plugin-ngmi-polyfill's People

Stargazers

Forkers

dewrin props-labs crcdng subframe7536 zizu-kun

vite-plugin-ngmi-polyfill's Issues

Plugin name

Is this plugin only for vite+react?
https://vitejs.dev/guide/api-plugin.html#conventions

Identifier 'Buffer' has already been declared, crypto has been externalized, etc.

I've tried using this plugin with vite to pollyfill the node api's and unfortunately it didn't work as expected. I included a minimal reproducible example here : https://github.com/Twiggeh/ngmi-report

update dependencies

SvelteKit now ships with vite 4.0.0 which breaks compatibility with this plugin ("vite": "^3").

Uncaught (in promise) TypeError: Object prototype may only be an Object or null: undefined

@esbuild-plugins/node-globals-polyfill/_buffer.js" cannot be marked as external

i've tried install esbuild polyfill get exactly same error with vite-plugin-ngmi-polyfill


  VITE v4.0.4  ready in 597 ms

  ➜  Local:   http://localhost:5173/
  ➜  Network: use --host to expose
  ➜  press h to show help
✘ [ERROR] The injected path "/Users/monsterstep/dev/chat-client/node_modules/@esbuild-plugins/node-globals-polyfill/_buffer.js" cannot be marked as external

✘ [ERROR] The injected path "/Users/monsterstep/dev/chat-client/node_modules/@esbuild-plugins/node-globals-polyfill/_virtual-process-polyfill_.js" cannot be marked as external

Build failed with 2 errors:
error: The injected path "/Users/monsterstep/dev/chat-client/node_modules/@esbuild-plugins/node-globals-polyfill/_buffer.js" cannot be marked as external
error: The injected path "/Users/monsterstep/dev/chat-client/node_modules/@esbuild-plugins/node-globals-polyfill/_virtual-process-polyfill_.js" cannot be marked as external
✘ [ERROR] Could not resolve "/Users/monsterstep/dev/chat-client/node_modules/@esbuild-plugins/node-globals-polyfill/_virtual-process-polyfill_.js"

1:14:11 PM [vite] error while updating dependencies:
Error: Build failed with 1 error:
error: Could not resolve "/Users/monsterstep/dev/chat-client/node_modules/@esbuild-plugins/node-globals-polyfill/_virtual-process-polyfill_.js"
    at failureErrorWithLog (/Users/monsterstep/dev/chat-client/node_modules/esbuild/lib/main.js:1596:15)
    at /Users/monsterstep/dev/chat-client/node_modules/esbuild/lib/main.js:1052:28
    at runOnEndCallbacks (/Users/monsterstep/dev/chat-client/node_modules/esbuild/lib/main.js:1468:61)
    at buildResponseToResult (/Users/monsterstep/dev/chat-client/node_modules/esbuild/lib/main.js:1050:7)
    at /Users/monsterstep/dev/chat-client/node_modules/esbuild/lib/main.js:1162:14
    at responseCallbacks.<computed> (/Users/monsterstep/dev/chat-client/node_modules/esbuild/lib/main.js:697:9)
    at handleIncomingPacket (/Users/monsterstep/dev/chat-client/node_modules/esbuild/lib/main.js:752:9)
    at Socket.readFromStdout (/Users/monsterstep/dev/chat-client/node_modules/esbuild/lib/main.js:673:7)
    at Socket.emit (node:events:527:28)
    at addChunk (node:internal/streams/readable:315:12)

rollup-plugin-node-polyfills or rollup-plugin-polyfill-node?

Hello. I just saw your package, and have a question / suggestion.

From https://github.com/FredKSchott/rollup-plugin-polyfill-node

This repo is an updated, maintained fork of https://github.com/ionic-team/rollup-plugin-node-polyfills to support better Node.js polyfills in Snowpack and all other Rollup projects. See this thread for discussion on moving this plugin into the official Rollup org: rollup/plugins#51 (comment)

I really don't know about all these packages for polyfilling node.js, but I guess in your case you want to use rollup-plugin-polyfill-node.