Allows proper 'define' option overwriting and specifying booleans/num…

…bers/valid JSON + adds test case
metalsmith · Jun 7, 2023 · 2992b6b · 2992b6b
1 parent 37d869e
commit 2992b6b
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 5 deletions.
diff --git a/src/index.js b/src/index.js
@@ -17,14 +17,19 @@ const debugNs = '@metalsmith/js-bundle'
 function normalizeOptions(options = {}, metalsmith, debug) {
   const entryPoints = options.entries || {}
   const isProd = metalsmith.env('NODE_ENV') !== 'development'
-  const define = Object.entries(metalsmith.env()).reduce((acc, [name, value]) => {
+  const define = Object.entries(options.define || metalsmith.env()).reduce((acc, [name, value]) => {
     if (typeof value === 'undefined') {
       debug.warn('Define option "%s" value is undefined', name)
       acc[`process.env.${name}`] = 'undefined'
       return acc
     }
     // see notes at https://esbuild.github.io/api/#define, string values require explicit quotes
-    acc[`process.env.${name}`] = typeof value === 'string' ? `'${value}'` : value.toString()
+    acc[`process.env.${name}`] =
+      typeof value === 'string'
+        ? `'${value}'`
+        : ['boolean', 'number', 'function'].includes(typeof value)
+        ? value.toString()
+        : JSON.stringify(value)
     return acc
   }, {})
 
@@ -36,8 +41,7 @@ function normalizeOptions(options = {}, metalsmith, debug) {
     platform: 'browser',
     target: 'es6',
     assetNames: '[dir]/[name]',
-    drop: isProd ? ['console', 'debugger'] : [],
-    define
+    drop: isProd ? ['console', 'debugger'] : []
   }
 
   /** @type {Options} */
@@ -46,7 +50,8 @@ function normalizeOptions(options = {}, metalsmith, debug) {
     absWorkingDir: metalsmith.directory(),
     outdir: relative(metalsmith.directory(), metalsmith.destination()),
     write: false,
-    metafile: true
+    metafile: true,
+    define
   }
 
   // eslint-disable-next-line no-unused-vars

diff --git a/test/fixtures/option-define/expected/index.js b/test/fixtures/option-define/expected/index.js
@@ -0,0 +1 @@
+(()=>{var e=["hello",1];var s={hello:"world"};window.env={strValue:"a string",boolValue:!1,numValue:66,arrValue:e,objValue:s};})();
diff --git a/test/fixtures/option-define/src/index.js b/test/fixtures/option-define/src/index.js
@@ -0,0 +1,7 @@
+window.env = {
+  strValue: process.env.STRVALUE,
+  boolValue: process.env.BOOLVALUE,
+  numValue: process.env.NUMVALUE,
+  arrValue: process.env.ARRVALUE,
+  objValue: process.env.OBJVALUE
+}
diff --git a/test/index.cjs b/test/index.cjs
@@ -92,6 +92,20 @@ const testcases = [
       entries: { index: './index.js' },
       target: 'es5'
     }
+  },
+  {
+    name: 'should correctly output "define" (env var) option values',
+    dir: 'option-define',
+    options: {
+      entries: { index: './src/index.js' },
+      define: {
+        STRVALUE: 'a string',
+        BOOLVALUE: false,
+        NUMVALUE: 66,
+        ARRVALUE: ['hello', 1],
+        OBJVALUE: { hello: 'world' }
+      }
+    }
   }
   // @TODO: add testcase for React/JSX
   // @TODO: add testcase for Typescript