fix: Add a nicer exported ESM wrapper and tweak the commonjs exported module

Author: rpl

bin/web-ext

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-var webExt = require('../dist/web-ext').default;
+var webExt = require('../dist/web-ext');
 var path = require('path');
 var absolutePackageDir = path.join(path.resolve(__dirname), '..');
 

index.mjs

@@ -0,0 +1,13 @@
+// This module provides a nicer ESM module wrapper around the module generated by webpack.
+
+// NOTE: disabled eslint rules:
+// - import/extensions: we need the explicit .js here to force node to look for the .js file instead of
+//   looking for a .mjs file.
+// - import/no-unresolved: the dist/web-ext.js file has likely not build yet when this runs in the CI jobs
+//   and this is also covered by automated tests (which would catch an unresolved import issue here).
+//
+// eslint-disable-next-line import/extensions, import/no-unresolved
+import webext from './dist/web-ext.js';
+
+export default webext;
+export const {cmd, main, util} = webext;

package.json

@@ -3,10 +3,16 @@
   "version": "4.3.0",
   "description": "A command line tool to help build, run, and test web extensions",
   "main": "dist/web-ext.js",
+  "exports": {
+    "import": "./index.mjs",
+    "require": "./dist/web-ext.js"
+  },
   "files": [
     "CODE_OF_CONDUCT.md",
+    "README.md",
     "dist/*.js",
-    "src/**"
+    "src/**",
+    "index.mjs"
   ],
   "engines": {
     "node": ">=10.0.0",

scripts/lib/config.js

@@ -14,7 +14,7 @@ module.exports = {
   },
   eslint: {
     files: [
-      '.', './src/**/*.js', './tests/**/*.js', './scripts/**',
+      '.', './index.mjs', './src/**/*.js', './tests/**/*.js', './scripts/**',
     ],
   },
   mocha: {

webpack.config.js

@@ -29,6 +29,9 @@ module.exports = {
     path: path.join(__dirname, 'dist'),
     filename: 'web-ext.js',
     libraryTarget: 'commonjs2',
+    // Force webpack bundled module to export the content
+    // of the default export.
+    libraryExport: 'default',
   },
   module: {
     rules,