fix(core): not load env files when NX_LOAD_DOT_ENV_FILES is false

nrwl · May 8, 2024 · c195d63 · c195d63
1 parent dc20a3b
commit c195d63
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 15 deletions.
diff --git a/docs/shared/reference/environment-variables.md b/docs/shared/reference/environment-variables.md
@@ -29,6 +29,7 @@ The following environment variables are ones that you can set to change the beha
 | NX_BATCH_MODE                    | boolean | If set to `true`, Nx will run task(s) in batches for executors which support batches.                                                                                                                                          |
 | NX_SKIP_LOG_GROUPING             | boolean | If set to `true`, Nx will not group command's logs on CI.                                                                                                                                                                      |
 | NX_MIGRATE_CLI_VERSION           | string  | The version of Nx to use for running the `nx migrate` command. If not set, it defaults to `latest`.                                                                                                                            |
+| NX_LOAD_DOT_ENV_FILES            | boolean | If set to 'false', Nx will not load any environment files (e.g. `.local.env`, `.env.local`)                                                                                                                                    |
 
 Nx will set the following environment variables so they can be accessible within the process even outside of executors and generators.
 

diff --git a/packages/nx/src/command-line/affected/affected.ts b/packages/nx/src/command-line/affected/affected.ts
@@ -32,7 +32,14 @@ export async function affected(
   extraTargetDependencies: Record<
     string,
     (TargetDependencyConfig | string)[]
-  > = {}
+  > = {},
+  extraOptions = {
+    excludeTaskDependencies: false,
+    loadDotEnvFiles: process.env.NX_LOAD_DOT_ENV_FILES !== 'false',
+  } as {
+    excludeTaskDependencies: boolean;
+    loadDotEnvFiles: boolean;
+  }
 ): Promise<void> {
   performance.mark('code-loading:end');
   performance.measure('code-loading', 'init-local', 'code-loading:end');
@@ -112,7 +119,7 @@ export async function affected(
             overrides,
             null,
             extraTargetDependencies,
-            { excludeTaskDependencies: false, loadDotEnvFiles: true }
+            extraOptions
           );
           process.exit(status);
         }

diff --git a/packages/nx/src/command-line/release/publish.ts b/packages/nx/src/command-line/release/publish.ts
@@ -93,8 +93,11 @@ export async function releasePublish(
         projectGraph,
         nxJson,
         Array.from(releaseGroupToFilteredProjects.get(releaseGroup)),
-        shouldExcludeTaskDependencies,
-        isCLI
+        isCLI,
+        {
+          excludeTaskDependencies: shouldExcludeTaskDependencies,
+          loadDotEnvFiles: process.env.NX_LOAD_DOT_ENV_FILES !== 'false',
+        }
       );
       if (status !== 0) {
         overallExitStatus = status || 1;
@@ -113,8 +116,11 @@ export async function releasePublish(
       projectGraph,
       nxJson,
       releaseGroup.projects,
-      shouldExcludeTaskDependencies,
-      isCLI
+      isCLI,
+      {
+        excludeTaskDependencies: shouldExcludeTaskDependencies,
+        loadDotEnvFiles: process.env.NX_LOAD_DOT_ENV_FILES !== 'false',
+      }
     );
     if (status !== 0) {
       overallExitStatus = status || 1;
@@ -129,8 +135,14 @@ async function runPublishOnProjects(
   projectGraph: ProjectGraph,
   nxJson: NxJsonConfiguration,
   projectNames: string[],
-  shouldExcludeTaskDependencies: boolean,
-  isCLI: boolean
+  isCLI: boolean,
+  extraOptions = {
+    excludeTaskDependencies: false,
+    loadDotEnvFiles: process.env.NX_LOAD_DOT_ENV_FILES !== 'false',
+  } as {
+    excludeTaskDependencies: boolean;
+    loadDotEnvFiles: boolean;
+  }
 ): Promise<number> {
   const projectsToRun: ProjectGraphProjectNode[] = projectNames.map(
     (projectName) => projectGraph.nodes[projectName]
@@ -218,10 +230,7 @@ async function runPublishOnProjects(
     overrides,
     null,
     {},
-    {
-      excludeTaskDependencies: shouldExcludeTaskDependencies,
-      loadDotEnvFiles: true,
-    }
+    extraOptions
   );
 
   if (status !== 0) {

diff --git a/packages/nx/src/command-line/run-many/run-many.ts b/packages/nx/src/command-line/run-many/run-many.ts
@@ -25,7 +25,10 @@ export async function runMany(
     string,
     (TargetDependencyConfig | string)[]
   > = {},
-  extraOptions = { excludeTaskDependencies: false, loadDotEnvFiles: true } as {
+  extraOptions = {
+    excludeTaskDependencies: false,
+    loadDotEnvFiles: process.env.NX_LOAD_DOT_ENV_FILES !== 'false',
+  } as {
     excludeTaskDependencies: boolean;
     loadDotEnvFiles: boolean;
   }

diff --git a/packages/nx/src/command-line/run/run-one.ts b/packages/nx/src/command-line/run/run-one.ts
@@ -27,7 +27,10 @@ export async function runOne(
     string,
     (TargetDependencyConfig | string)[]
   > = {},
-  extraOptions = { excludeTaskDependencies: false, loadDotEnvFiles: true } as {
+  extraOptions = {
+    excludeTaskDependencies: false,
+    loadDotEnvFiles: process.env.NX_LOAD_DOT_ENV_FILES !== 'false',
+  } as {
     excludeTaskDependencies: boolean;
     loadDotEnvFiles: boolean;
   }

diff --git a/packages/nx/src/executors/run-commands/run-commands.impl.ts b/packages/nx/src/executors/run-commands/run-commands.impl.ts
@@ -106,7 +106,9 @@ export default async function (
   terminalOutput: string;
 }> {
   registerProcessListener();
-  await loadEnvVars(options.envFile);
+  if (process.env.NX_LOAD_DOT_ENV_FILES !== 'false') {
+    await loadEnvVars(options.envFile);
+  }
   const normalized = normalizeOptions(options);
 
   if (options.readyWhen && !options.parallel) {