feat(core): specify a custom .env file for workspace:run-commands (#2505

)

* feat(core): add envFile option to commands runner

* feat(core): add tests for dotenv functionality in command runner

docs/angular/api-workspace/builders/run-commands.md

@@ -30,6 +30,12 @@ Type: `string`
 
 Command to run in child process
 
+### envFile
+
+Type: `string`
+
+You may specify a custom .env file path if your file containing environment variables is located elsewhere.
+
 ### outputPath
 
 Type: `string`

docs/react/api-workspace/builders/run-commands.md

@@ -31,6 +31,12 @@ Type: `string`
 
 Command to run in child process
 
+### envFile
+
+Type: `string`
+
+You may specify a custom .env file path if your file containing environment variables is located elsewhere.
+
 ### outputPath
 
 Type: `string`

docs/web/api-workspace/builders/run-commands.md

@@ -31,6 +31,12 @@ Type: `string`
 
 Command to run in child process
 
+### envFile
+
+Type: `string`
+
+You may specify a custom .env file path if your file containing environment variables is located elsewhere.
+
 ### outputPath
 
 Type: `string`

packages/workspace/src/builders/run-commands/run-commands.impl.spec.ts

@@ -1,6 +1,6 @@
 import { schema } from '@angular-devkit/core';
 import { fileSync } from 'tmp';
-import { readFileSync } from 'fs';
+import { readFileSync, writeFileSync, unlinkSync } from 'fs';
 import { TestingArchitectHost } from '@angular-devkit/architect/testing';
 import { Architect } from '@angular-devkit/architect';
 import { join } from 'path';
@@ -270,4 +270,79 @@ describe('Command Runner Builder', () => {
       });
     });
   });
+
+  describe('dotenv', () => {
+    beforeAll(() => {
+      writeFileSync('.env', 'NRWL_SITE=https://nrwl.io/');
+    });
+
+    beforeEach(() => {
+      delete process.env.NRWL_SITE;
+      delete process.env.NX_SITE;
+    });
+
+    afterAll(() => {
+      unlinkSync('.env');
+    });
+
+    it('should load the root .env file by default if there is one', async () => {
+      let f = fileSync().name;
+      let run = await architect.scheduleBuilder(
+        '@nrwl/workspace:run-commands',
+        {
+          commands: [
+            {
+              command: `echo $NRWL_SITE >> ${f}`
+            }
+          ]
+        }
+      );
+
+      let result = await run.result;
+
+      expect(result).toEqual(jasmine.objectContaining({ success: true }));
+      expect(readFile(f)).toEqual('https://nrwl.io/');
+    });
+
+    it('should load the specified .env file instead of the root one', async () => {
+      const devEnv = fileSync().name;
+      writeFileSync(devEnv, 'NX_SITE=https://nx.dev/');
+      let f = fileSync().name;
+      let run = await architect.scheduleBuilder(
+        '@nrwl/workspace:run-commands',
+        {
+          commands: [
+            {
+              command: `echo $NX_SITE >> ${f} && echo $NRWL_SITE >> ${f}`
+            }
+          ],
+          envFile: devEnv
+        }
+      );
+
+      let result = await run.result;
+
+      expect(result).toEqual(jasmine.objectContaining({ success: true }));
+      expect(readFile(f)).toEqual('https://nx.dev/');
+    });
+
+    it('should error if the specified .env file does not exist', async () => {
+      let f = fileSync().name;
+      let run = await architect.scheduleBuilder(
+        '@nrwl/workspace:run-commands',
+        {
+          commands: [
+            {
+              command: `echo $NX_SITE >> ${f} && echo $NRWL_SITE >> ${f}`
+            }
+          ],
+          envFile: '/somePath/.fakeEnv'
+        }
+      );
+
+      await expect(run.result).rejects.toThrow(
+        `no such file or directory, open '/somePath/.fakeEnv'`
+      );
+    });
+  });
 });

packages/workspace/src/builders/run-commands/run-commands.impl.ts

@@ -8,16 +8,26 @@ import { exec } from 'child_process';
 import { Observable } from 'rxjs';
 import { TEN_MEGABYTES } from '@nrwl/workspace/src/core/file-utils';
 
-try {
-  require('dotenv').config();
-} catch (e) {}
+function loadEnvVars(path?: string) {
+  if (path) {
+    const result = require('dotenv').config({ path });
+    if (result.error) {
+      throw result.error;
+    }
+  } else {
+    try {
+      require('dotenv').config();
+    } catch (e) {}
+  }
+}
 
 export interface RunCommandsBuilderOptions extends JsonObject {
   commands: { command: string }[];
   color?: boolean;
   parallel?: boolean;
   readyWhen?: string;
   args?: string;
+  envFile?: string;
   parsedArgs?: { [key: string]: string };
 }
 
@@ -27,6 +37,7 @@ function run(
   options: RunCommandsBuilderOptions,
   context: BuilderContext
 ): Observable<BuilderOutput> {
+  loadEnvVars(options.envFile);
   options.parsedArgs = parseArgs(options.args);
   return Observable.create(async observer => {
     if (!options.commands) {

packages/workspace/src/builders/run-commands/schema.json

@@ -30,6 +30,10 @@
       "type": "string",
       "description": "Extra arguments. You can pass them as follows: ng run project:target --args='--wait=100'. You can them use {args.wait} syntax to interpolate them in the workspace config file."
     },
+    "envFile": {
+      "type": "string",
+      "description": "You may specify a custom .env file path if your file containing environment variables is located elsewhere."
+    },
     "color": {
       "type": "boolean",
       "description": "Use colors when showing output of command",