vite-plugin-esmodule

Build ES module to CommonJs module for Node.js

English | 简体中文

Why

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

👉 You can think that this plugin is to solve some NPM Packges released by sindresorhus 😅

🚧 The plugin only work in the vite build phase

Usage

Take execa, node-fetch and file-type as examples

• vite.config.js

import esmodule from 'vite-plugin-esmodule'

export default {
  plugins: [
    esmodule([
      'execa',
      'file-type',
      // or
      // file-type have exports condition in package.json
      // { 'file-type': 'file-type/index.js' },
    ], {
      webpack: true, // -> default use webpack
      // or
      // vite: true, // -> there may be some problems
    }),
  ],
}

• execa.js

import {execa} from 'execa';

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

See the test cases

API

esmodule(modules[,options])

modules: ES module name list

modules: (string | { [module: string]: string })[]

options:

options?: WebpackOptions | ViteOptions

export interface WebpackOptions {
  webpack?: true | ((config: Configuration) => Configuration | void | Promise<Configuration | void>);
  vite?: never;
}

export interface ViteOptions {
  vite?: true | ((config: UserConfig) => UserConfig | void | Promise<UserConfig | void>);
  webpack?: never;
}

How to work

This plugin just wraps vite-plugin-optimizer