Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/pakholeung37/vite-plugin-treat-umd-as-commonjs

Make code runs when using requireJS/AMD in browser with vite
https://github.com/pakholeung37/vite-plugin-treat-umd-as-commonjs

amd-modules requirejs vite vite-plugin

Last synced: about 2 months ago
JSON representation

Make code runs when using requireJS/AMD in browser with vite

Awesome Lists containing this project

README

        

# vite-plugin-treat-umd-as-commonjs

Make code runs when using requireJS/amd in browser with vite. This plugin is for a paticular edge case. check [RequireJS environment in browser will break the UMD module conversion](https://github.com/vitejs/vite/issues/5900)

[![NPM](https://nodei.co/npm/vite-plugin-treat-umd-as-commonjs.png)](https://npmjs.org/package/vite-plugin-treat-umd-as-commonjs/)

## Usage

```javascript
// vite.config.js
const { defineConfig } = require("vite");
const { treatAsCommonjs } = require("vite-plugin-treat-umd-as-commonjs");

module.exports = defineConfig({
plugins: [treatAsCommonjs()],
});
```

It will simple add `var define = false;` in modules from node_modules by default which avoid the browser requireJS/amd environment to register the module to amd. You can also specifically include or exclude pattern.

## Options

```javascript
type Options = {
// moduleId/files to include
indluce?: Array | string | RegExp
// moduleId/files to exclude
exclude?: Array | string | RegExp
}
```

## License

[MIT](LICENSE)