vite-plugin-esmodule

Build ES module to CommonJs module for Node.js

English | 简体中文

Why

When ES module such as execa, node-fetch used in the Node.js project, we should compile them into CommonJs modules to ensure that they can work

📢 The plugin only work in the vite build phase

Usage

Take execa and node fetch as examples

• vite.config.js

import esmodule from 'vite-plugin-esmodule'

export default {
  plugins: [
    esmodule([
      'execa',
      'node-fetch',
    ]),
  ],
}

• execa.js

import {execa} from 'execa';

const {stdout} = await execa('echo', ['unicorns']);
console.log(stdout);
//=> 'unicorns'

• node-fetch.js

import fetch from 'node-fetch';

const response = await fetch('https://github.com/');
const body = await response.text();

console.log(body);

See the test cases

API

esmodule(modules: string[])

modules: ES module name list

How to work

The plugin will use the build API of Vite to build ES module into the node_modules/.vite-plugin-esmodule directory
Then point to the built path by modifying resolve.alias