Add option to pass env variables from launch configuration (#156)

software-mansion · Apr 25, 2024 · c85e2fd · c85e2fd
1 parent 1f289e1
commit c85e2fd
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 3 deletions.
diff --git a/packages/docs/docs/launch-configuration.md b/packages/docs/docs/launch-configuration.md
@@ -127,8 +127,9 @@ Below is an example of how the `launch.json` file could look like with android v
 Here, we list other attributes that can be configured using launch configuration which doesn't fit in any of the above categories:
 
 - `appRoot` – Location of the React Native application root folder relative to the workspace. This is used for monorepo type setups when the workspace root is not the root of the React Native project. The IDE extension tries to locate the React Native application root automatically, but in case it failes to do so (i.e. there are multiple applications defined in the workspace), you can use this setting to override the location.
+- `env` – Environment variables to be passed to all build/run commands that the IDE is launching.
 
-Below is a sample `launch.json` config file with `appRoot` setting specified:
+Below is a sample `launch.json` config file with `appRoot` and `env` setting specified:
 
 ```json
 {
@@ -138,7 +139,10 @@ Below is a sample `launch.json` config file with `appRoot` setting specified:
       "type": "react-native-ide",
       "request": "launch",
       "name": "React Native IDE panel",
-      "appRoot": "packages/mobile"
+      "appRoot": "packages/mobile",
+      "env": {
+        "MY_SECRET_KEY": "bananas"
+      }
     }
   ]
 }

diff --git a/packages/vscode-extension/package.json b/packages/vscode-extension/package.json
@@ -134,6 +134,10 @@
                 "type": "string",
                 "description": "Location of the React Native application root folder relative to the workspace. This is used for monorepo type setups when the workspace root is not the root of the React Native project. The IDE extension tries to locate the React Native application root automatically, but in case it failes to do so (i.e. there are multiple applications defined in the workspace), you can use this setting to override the location."
               },
+              "env": {
+                "type": "object",
+                "description": "Environment variables to be passed to all build/run commands that the IDE is launching."
+              },
               "ios": {
                 "description": "Provides a way to customize Xcode builds for iOS",
                 "type": "object",

diff --git a/packages/vscode-extension/src/builders/buildAndroid.ts b/packages/vscode-extension/src/builders/buildAndroid.ts
@@ -74,7 +74,7 @@ export async function buildAndroid(
   const buildProcess = cancelToken.adapt(
     exec("./gradlew", gradleArgs, {
       cwd: androidSourceDir,
-      env: { ...process.env, JAVA_HOME, ANDROID_HOME },
+      env: { ...process.env, ...buildOptions.env, JAVA_HOME, ANDROID_HOME },
       buffer: false,
     })
   );

diff --git a/packages/vscode-extension/src/builders/buildIOS.ts b/packages/vscode-extension/src/builders/buildIOS.ts
@@ -93,6 +93,7 @@ function buildProject(
   return exec("xcodebuild", xcodebuildArgs, {
     env: {
       ...process.env,
+      ...getLaunchConfiguration().env,
       RCT_NO_LAUNCH_PACKAGER: "true",
     },
     cwd: buildDir,

diff --git a/packages/vscode-extension/src/dependency/DependencyInstaller.ts b/packages/vscode-extension/src/dependency/DependencyInstaller.ts
@@ -4,6 +4,7 @@ import { DependencyChecker } from "./DependencyChecker";
 import { command } from "../utilities/subprocess";
 import { getIosSourceDir } from "../builders/buildIOS";
 import { getAppRootFolder } from "../utilities/extensionContext";
+import { getLaunchConfiguration } from "../utilities/launchConfiguration";
 
 export class DependencyInstaller implements Disposable {
   private webview: Webview;
@@ -70,6 +71,7 @@ export function installIOSDependencies(appRootFolder: string, forceCleanBuild: b
     cwd: iosDirPath,
     env: {
       ...process.env,
+      ...getLaunchConfiguration().env,
       LANG: "en_US.UTF-8",
     },
   });

diff --git a/packages/vscode-extension/src/project/metro.ts b/packages/vscode-extension/src/project/metro.ts
@@ -5,6 +5,7 @@ import { Logger } from "../Logger";
 import { extensionContext, getAppRootFolder } from "../utilities/extensionContext";
 import { Devtools } from "./devtools";
 import stripAnsi from "strip-ansi";
+import { getLaunchConfiguration } from "../utilities/launchConfiguration";
 
 export interface MetroDelegate {
   onBundleError(): void;
@@ -133,6 +134,7 @@ export class Metro implements Disposable {
 
     const metroEnv = {
       ...process.env,
+      ...getLaunchConfiguration().env,
       NODE_PATH: path.join(appRootFolder, "node_modules"),
       RCT_METRO_PORT: "0",
       RCT_DEVTOOLS_PORT: this.devtools.port.toString(),

diff --git a/packages/vscode-extension/src/utilities/launchConfiguration.ts b/packages/vscode-extension/src/utilities/launchConfiguration.ts
@@ -2,6 +2,7 @@ import { workspace } from "vscode";
 
 export type LaunchConfigurationOptions = {
   appRoot: string | undefined;
+  env: Record<string, string> | undefined;
   ios:
     | {
         scheme: string | undefined;