Merge pull request #9 from vite-plugin/v1.4.3

V1.4.3

Author: caoxiemeihao

.gitignore

@@ -109,3 +109,5 @@ dist
 package-lock.json
 pnpm-lock.yaml
 yarn.lock
+
+/index.mjs

CHANGELOG.md

@@ -1,3 +1,11 @@
+## [2022-10-17] v1.4.3
+
+- e9201bf v1.4.3
+- e28a9f9 docs: v1.4.3
+- 2bd756b feat: add test
+- 6f2266c feat: support `"type": "module"`
+- bddbc85 refactor: use lib-esm
+- 8b905b3 fix(#8): type define
 
 ## [2022-07-26] v1.4.2
 

README.md

@@ -50,22 +50,19 @@ console.log(stdout);
 
 <!-- [👉 See test](https://github.com/vite-plugin/vite-plugin-esmodule/test) -->
 
-## API
+## API <sub><sup>(Define)</sup></sub>
 
 `esmodule(modules[, webpack])`
 
 ```ts
-import type { Plugin } from 'vite'
 import type { Configuration } from 'webpack'
 
-export type ModuleRecord = string | { [module: string]: string }
+type ModuleRecord = string | { [module: string]: string }
 
-declare function exports(
+function esmodule(
   modules: ModuleRecord[] | ((esmPkgs: string[]) => ModuleRecord[]),
   webpack?: ((config: Configuration) => Configuration | void | Promise<Configuration | void>),
-): Plugin
-
-export = exports
+): import('vite').Plugin
 ```
 
 ## How to work

build.js

@@ -0,0 +1,12 @@
+const fs = require('fs');
+const path = require('path');
+const libEsm = require('lib-esm');
+
+// const iswatch = process.argv.slice(2).includes('--watch');
+
+const filename = path.join(__dirname, 'index.js');
+const destname = filename.replace('.js', '.mjs');
+const result = libEsm({ require: './index.js', exports: Object.keys(require('.')) });
+fs.writeFileSync(destname, `${result.require}\n${result.exports}`);
+
+console.log('build success');

index.d.ts

@@ -1,11 +1,13 @@
-import type { Plugin } from 'vite'
-import type { Configuration } from 'webpack'
+declare module 'vite-plugin-esmodule' {
+  import type { Configuration } from 'webpack'
 
-export type ModuleRecord = string | { [module: string]: string }
+  type ModuleRecord = string | { [module: string]: string }
 
-declare function exports(
-  modules: ModuleRecord[] | ((esmPkgs: string[]) => ModuleRecord[]),
-  webpack?: ((config: Configuration) => Configuration | void | Promise<Configuration | void>),
-): Plugin
+  function esmodule(
+    modules: ModuleRecord[] | ((esmPkgs: string[]) => ModuleRecord[]),
+    webpack?: ((config: Configuration) => Configuration | void | Promise<Configuration | void>),
+  ): import('vite').Plugin
 
-export = exports
+  // https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-d-ts.html#default-exports
+  export = esmodule
+}

index.js

@@ -2,14 +2,15 @@ const fs = require('fs');
 const path = require('path');
 const webpack = require('webpack');
 const optimizer = require('vite-plugin-optimizer');
+const libEsm = require('lib-esm');
 
 const PLUGIN_NAME = 'vite-plugin-esmodule';
 const CACHE_DIR = `.${PLUGIN_NAME}`;
 
 /**
  * @type {import('.')}
  */
-module.exports = function esmodule(modules, webpackFn) {
+function esmodule(modules, webpackFn) {
   /**
    * @type {import('vite').ConfigEnv}
    */
@@ -43,7 +44,7 @@ module.exports = function esmodule(modules, webpackFn) {
   }
 
   if (!Array.isArray(modules)) {
-    throw new Error(`(modules) expects an array, but got: ${modules}`);
+    throw new Error(`[vite-plugin-esmodule] esmodule(modules) expects an array, but got: ${modules}`);
   }
 
   /**
@@ -155,27 +156,22 @@ function logError(error, exit = true) {
 }
 
 /**
- * @type {(args: import('vite-plugin-optimizer').OptimizerArgs, ...args: Parameters<import('.').Esmodule>) => Promise<void>}
+ * @type {(options: import('vite-plugin-optimizer').OptimizerArgs, ...args: Parameters<import('vite-plugin-esmodule')>) => Promise<void>}
  */
-function writeElectronRendererServeESM(args, modules) {
+function writeElectronRendererServeESM(options, modules) {
   for (const mod of modules) {
     const moduleName = typeof mod === 'object' ? Object.keys(mod)[0] : mod
-    const { cjsId, electronRendererId } = getModuleId(path.join(args.dir, moduleName));
-
-    // 🚧 For Electron-Renderer
-    const cjsModule = require(cjsId);
-    const requireModule = `const _M_ = require("${CACHE_DIR}/${moduleName}");`;
-    const exportDefault = `const _D_ = _M_.default || _M_;\nexport { _D_ as default };`;
-    const exportMembers = Object
-      .keys(cjsModule)
-      .filter(n => n !== 'default')
-      .map(attr => `export const ${attr} = _M_.${attr};`).join('\n')
-    const esmModuleCodeSnippet = `
-${requireModule}
-${exportDefault}
-${exportMembers}
-`.trim();
-    fs.writeFileSync(electronRendererId, esmModuleCodeSnippet);
+    const { cjsId, electronRendererId } = getModuleId(path.join(options.dir, moduleName));
+    const result = libEsm({
+      require: `${CACHE_DIR}/${moduleName}`,
+      exports: Object.keys(require(cjsId)),
+    });
+
+    fs.writeFileSync(
+      ensureDir(electronRendererId),
+      // `const _M_ = require("${CACHE_DIR}/${moduleName}");\n${result.exports}`,
+      `const _M_ = require("./index.js");\n${result.exports}`,
+    );
   }
 }
 
@@ -200,3 +196,18 @@ function lookupFile(filename, paths) {
     }
   }
 }
+
+function ensureDir(filename) {
+  const dirname = path.dirname(filename);
+  !fs.existsSync(dirname) && fs.mkdirSync(dirname, { recursive: true });
+  return filename;
+}
+
+esmodule.__test__ = {
+  CACHE_DIR,
+  ensureDir,
+  getModuleId,
+  writeElectronRendererServeESM,
+};
+
+module.exports = esmodule;

package.json

@@ -1,10 +1,18 @@
 {
   "name": "vite-plugin-esmodule",
-  "version": "1.4.2",
+  "version": "1.4.3",
   "description": "Build ES module to CommonJs module for Node.js/Electron",
   "main": "index.js",
+  "exports": {
+    ".": {
+      "import": "./index.mjs",
+      "require": "./index.js"
+    }
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "node build.js",
+    "test": "node test/index.js",
+    "prepublishOnly": "npm run build"
   },
   "repository": {
     "type": "git",
@@ -26,10 +34,17 @@
   },
   "homepage": "https://github.com/vite-plugin/vite-plugin-esmodule#readme",
   "dependencies": {
-    "vite-plugin-optimizer": "^1.3.4",
-    "webpack": "^5.73.0"
+    "lib-esm": "~0.2.0",
+    "vite-plugin-optimizer": "~1.4.1",
+    "webpack": "^5.74.0"
   },
   "devDependencies": {
-    "vite": "^2.9.9"
-  }
+    "got": "^12.5.2",
+    "vite": "^3.2.0-beta.2"
+  },
+  "files": [
+    "index.js",
+    "index.mjs",
+    "index.d.ts"
+  ]
 }

test/-.js

@@ -0,0 +1,3 @@
+import got from 'got'
+
+console.log(got)

test/.gitignore

@@ -0,0 +1 @@
+/-.mjs

test/__snapshots__/got/index.electron-renderer.js

@@ -0,0 +1,23 @@
+const _M_ = require("./index.js");
+export const AbortError = _M_.AbortError;
+export const CacheError = _M_.CacheError;
+export const CancelError = _M_.CancelError;
+export const HTTPError = _M_.HTTPError;
+export const MaxRedirectsError = _M_.MaxRedirectsError;
+export const Options = _M_.Options;
+export const ParseError = _M_.ParseError;
+export const ReadError = _M_.ReadError;
+export const RequestError = _M_.RequestError;
+export const RetryError = _M_.RetryError;
+export const TimeoutError = _M_.TimeoutError;
+export const UploadError = _M_.UploadError;
+export const calculateRetryDelay = _M_.calculateRetryDelay;
+export const create = _M_.create;
+export const keyword_default = _M_.default || _M_;
+export const got = _M_.got;
+export const isResponseOk = _M_.isResponseOk;
+export const parseBody = _M_.parseBody;
+export const parseLinkHeader = _M_.parseLinkHeader;
+export {
+  keyword_default as default,
+};