Merge pull request #12 from vite-plugin/v1.5.0

V1.5.0

Author: caoxiemeihao

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [2023-05-13] v1.5.0
+
+- b0df1c0 feat: support custom `webpack` version
+
 ## [2022-10-19] v1.4.4
 
 - 952da00 v1.4.4

README.md

@@ -14,7 +14,7 @@ When using ES modules(e.g.`node-fetch`) in Node.js/Electron projects, we may nee
 ## Install
 
 ```sh
-npm i vite-plugin-esmodule -D
+npm i -D vite-plugin-esmodule webpack
 ```
 
 ## Usage

build.js

@@ -1,6 +1,6 @@
 const fs = require('fs');
 const path = require('path');
-const libEsm = require('lib-esm');
+const libEsm = require('lib-esm').default;
 
 // const iswatch = process.argv.slice(2).includes('--watch');
 

index.js

@@ -1,16 +1,23 @@
 const fs = require('fs');
 const path = require('path');
-const webpack = require('webpack');
 const optimizer = require('vite-plugin-optimizer');
-const libEsm = require('lib-esm');
+const libEsm = require('lib-esm').default;
 
 const PLUGIN_NAME = 'vite-plugin-esmodule';
+const TAG = `[${PLUGIN_NAME}]`;
 const CACHE_DIR = `.${PLUGIN_NAME}`;
 
 /**
- * @type {import('.')}
+ * @type {import('vite-plugin-esmodule')}
  */
 function esmodule(modules, webpackFn) {
+  try {
+    require.resolve('webpack');
+  } catch (error) {
+    console.log(TAG, '"webpack" is a required dependency, make sure you have it installed?');
+    return;
+  }
+
   /**
    * @type {import('vite').ConfigEnv}
    */
@@ -93,38 +100,21 @@ function esmodule(modules, webpackFn) {
 };
 
 /**
- * @type {(args: import('vite-plugin-optimizer').OptimizerArgs, ...args: Parameters<import('.').Esmodule>) => Promise<void>}
+ * @type {(args: import('vite-plugin-optimizer').OptimizerArgs, ...args: Parameters<import('vite-plugin-esmodule')>) => Promise<void>}
  */
-async function buildESModules(args, modules, webpackFn) {
-  const entries = modules.reduce((memo, mod) => {
-    const [key, val] = typeof mod === 'object' ? Object.entries(mod)[0] : [mod, mod];
-    return Object.assign(memo, {
-      // This is essentially an alias
-      // e.g. { esm-pkg: 'node_modules/.vite-plugin-esmodule/esm-pkg.js' }
-      [key]: require.resolve(val),
-    });
-  }, {});
-
-  /**
-   * @type {import('webpack').Configuration}
-   */
-  let config = {
-    mode: 'none',
-    target: 'node14',
-    entry: entries,
-    output: {
-      library: {
-        type: 'commonjs2',
-      },
-      path: args.dir,
-      filename: '[name]/index.js',
-    },
-  };
-  if (typeof webpackFn === 'function') {
-    config = webpackFn(config) || config;
-  }
+async function buildESModules(
+  args,
+  modules,
+  webpackFn,
+) {
+  await new Promise(async resolve => {
+    const webpack = require('webpack');
+    const config = await resolveWebpackConfig(
+      modules,
+      args.dir,
+      webpackFn,
+    );
 
-  await new Promise(resolve => {
     fs.rmSync(args.dir, { recursive: true, force: true });
 
     // Whey use Webpack?
@@ -204,6 +194,48 @@ function ensureDir(filename) {
   return filename;
 }
 
+function modules2entries(modules) {
+  return modules.reduce((memo, mod) => {
+    const [key, val] = typeof mod === 'object' ? Object.entries(mod)[0] : [mod, mod];
+    return Object.assign(memo, {
+      // This is essentially an alias
+      // e.g. { esm-pkg: 'node_modules/.vite-plugin-esmodule/esm-pkg.js' }
+      [key]: require.resolve(val),
+    });
+  }, {});
+}
+
+/**
+ * @type {(
+ *   modules: Record<string, string>,
+ *   outputPath: string,
+ *   webpackFn: Parameters<import('vite-plugin-esmodule')>[1]
+ * ) => Promise<import('webpack').Configuration>}
+ */
+function resolveWebpackConfig(
+  modules,
+  outputPath,
+  webpackFn,
+) {
+  /**
+   * @type {import('webpack').Configuration}
+   */
+  const config = {
+    mode: 'none',
+    target: 'node14',
+    entry: modules2entries(modules),
+    output: {
+      library: {
+        type: 'commonjs2',
+      },
+      path: outputPath,
+      filename: '[name]/index.js',
+    },
+  };
+
+  return typeof webpackFn === 'function' ? webpackFn(config) : config;
+}
+
 esmodule.__test__ = {
   CACHE_DIR,
   ensureDir,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-esmodule",
-  "version": "1.4.4",
+  "version": "1.5.0",
   "description": "Build ES module to CommonJs module for Node.js/Electron",
   "main": "index.js",
   "exports": {
@@ -34,13 +34,21 @@
   },
   "homepage": "https://github.com/vite-plugin/vite-plugin-esmodule#readme",
   "dependencies": {
-    "lib-esm": "~0.3.0",
-    "vite-plugin-optimizer": "~1.4.2",
-    "webpack": "^5.74.0"
+    "lib-esm": "~0.4.0",
+    "vite-plugin-optimizer": "~1.4.2"
+  },
+  "peerDependencies": {
+    "webpack": "*"
+  },
+  "peerDependenciesMeta": {
+    "webpack": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "file-type": "^18.0.0",
-    "vite": "^3.2.0-beta.2"
+    "vite": "^4.3.5",
+    "webpack": "^5.82.1"
   },
   "files": [
     "index.js",

test/index.js

@@ -8,6 +8,8 @@ const vite = require('vite');
 const esmodule = require('vite-plugin-esmodule');
 const test = esmodule.__test__;
 const moduleName = 'file-type';
+
+const TAG = '[test]';
 const node_modules = path.join(__dirname, '../node_modules');
 const __snapshots__ = path.join(__dirname, '__snapshots__');
 
@@ -63,6 +65,6 @@ function runTest() {
   child.stdout.on('data', chunk => {
     const str = chunk.toString().trim();
     assert.equal(str, '[AsyncFunction: fileTypeFromFile]');
-    console.log('test success');
+    console.log(TAG, 'index.js passed ✅');
   });
 }