feat(build/serve): add support for env vars in main process, closes #83

Author: nklayman

__tests__/commands.spec.js

@@ -249,6 +249,14 @@ describe('build:electron', () => {
     expect(serviceRun).not.toBeCalled()
     expect(webpack).not.toBeCalled()
   })
+
+  test('Env vars prefixed with VUE_APP_ are available in main process config', async () => {
+    process.env.VUE_APP_TEST = 'expected'
+    await runCommand('serve:electron')
+    const mainConfig = webpack.mock.calls[0][0]
+    // Env var is set correctly
+    expect(mainConfig.plugins[1].defaultValues.VUE_APP_TEST).toBe('expected')
+  })
 })
 
 describe('serve:electron', () => {
@@ -503,6 +511,14 @@ describe('Custom webpack chain', () => {
       'chainableConfig'
     )
   })
+
+  test('Env vars prefixed with VUE_APP_ are available in main process config', async () => {
+    process.env.VUE_APP_TEST = 'expected'
+    await runCommand('serve:electron')
+    const mainConfig = webpack.mock.calls[0][0]
+    // Env var is set correctly
+    expect(mainConfig.plugins[1].defaultValues.VUE_APP_TEST).toBe('expected')
+  })
 })
 
 describe('testWithSpectron', async () => {

docs/guide/guide.md

@@ -95,6 +95,10 @@ console.log(fileContents)
 ├── ...
 ```
 
+## Env Variables
+
+Read [Vue ClI's documentation](https://cli.vuejs.org/guide/mode-and-env.html) to learn about using environment variables in your app. All env variables prefixed with `VUE_APP_` will be available in both the main and renderer processes.
+
 ## How it works
 
 ### Build Command

index.js

@@ -342,14 +342,19 @@ function bundleMain ({
         __static: JSON.stringify(api.resolve('./public'))
       }
     ])
-    config.plugin('env').use(webpack.EnvironmentPlugin, [
-      {
-        // Dev server url
-        WEBPACK_DEV_SERVER_URL: server.url,
-        // Path to node_modules (for externals in development)
-        NODE_MODULES_PATH: api.resolve('./node_modules')
+    const envVars = {
+      // Dev server url
+      WEBPACK_DEV_SERVER_URL: server.url,
+      // Path to node_modules (for externals in development)
+      NODE_MODULES_PATH: api.resolve('./node_modules')
+    }
+    // Add all env vars prefixed with VUE_APP_
+    Object.keys(process.env).forEach(k => {
+      if (/^VUE_APP_/.test(k)) {
+        envVars[k] = process.env[k]
       }
-    ])
+    })
+    config.plugin('env').use(webpack.EnvironmentPlugin, [envVars])
   }
   if (args.debug) {
     // Enable source maps for debugging