feat(core): ability to save task graph to a file when running --graph

nrwl · May 8, 2023 · d702cf1 · d702cf1
1 parent 67a5e8e
commit d702cf1
Show file tree

Hide file tree

Showing 11 changed files with 43 additions and 16 deletions.
diff --git a/docs/generated/cli/affected.md b/docs/generated/cli/affected.md
@@ -99,11 +99,11 @@ Change the way Nx is calculating the affected command by providing directly chan
 
 ### graph
 
-Type: `boolean`
+Type: `string`
 
 Default: `false`
 
-Show the task graph of the command
+Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser.
 
 ### head
 

diff --git a/docs/generated/cli/exec.md b/docs/generated/cli/exec.md
@@ -31,11 +31,11 @@ Exclude certain projects from being processed
 
 ### graph
 
-Type: `boolean`
+Type: `string`
 
 Default: `false`
 
-Show the task graph of the command
+Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser.
 
 ### nx-bail
 

diff --git a/docs/generated/cli/run-many.md b/docs/generated/cli/run-many.md
@@ -83,11 +83,11 @@ Exclude certain projects from being processed
 
 ### graph
 
-Type: `boolean`
+Type: `string`
 
 Default: `false`
 
-Show the task graph of the command
+Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser.
 
 ### help
 

diff --git a/docs/generated/packages/nx/documents/affected.md b/docs/generated/packages/nx/documents/affected.md
@@ -99,11 +99,11 @@ Change the way Nx is calculating the affected command by providing directly chan
 
 ### graph
 
-Type: `boolean`
+Type: `string`
 
 Default: `false`
 
-Show the task graph of the command
+Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser.
 
 ### head
 

diff --git a/docs/generated/packages/nx/documents/exec.md b/docs/generated/packages/nx/documents/exec.md
@@ -31,11 +31,11 @@ Exclude certain projects from being processed
 
 ### graph
 
-Type: `boolean`
+Type: `string`
 
 Default: `false`
 
-Show the task graph of the command
+Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser.
 
 ### nx-bail
 

diff --git a/docs/generated/packages/nx/documents/run-many.md b/docs/generated/packages/nx/documents/run-many.md
@@ -83,11 +83,11 @@ Exclude certain projects from being processed
 
 ### graph
 
-Type: `boolean`
+Type: `string`
 
 Default: `false`
 
-Show the task graph of the command
+Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser.
 
 ### help
 

diff --git a/packages/nx/src/command-line/affected/affected.ts b/packages/nx/src/command-line/affected/affected.ts
@@ -83,14 +83,19 @@ export async function affected(
         const projectsWithTarget = allProjectsWithTarget(projects, nxArgs);
         if (nxArgs.graph) {
           const projectNames = projectsWithTarget.map((t) => t.name);
-
+          const file =
+            typeof nxArgs.graph === 'string' &&
+            (nxArgs.graph.endsWith('.json') || nxArgs.graph.endsWith('html'))
+              ? nxArgs.graph
+              : undefined;
           return await generateGraph(
             {
               watch: false,
               open: true,
               view: 'tasks',
               targets: nxArgs.targets,
               projects: projectNames,
+              file,
             },
             projectNames
           );

diff --git a/packages/nx/src/command-line/run-many/run-many.ts b/packages/nx/src/command-line/run-many/run-many.ts
@@ -46,6 +46,11 @@ export async function runMany(
   const projects = projectsToRun(nxArgs, projectGraph);
 
   if (nxArgs.graph) {
+    const file =
+      typeof nxArgs.graph === 'string' &&
+      (nxArgs.graph.endsWith('.json') || nxArgs.graph.endsWith('html'))
+        ? nxArgs.graph
+        : undefined;
     const projectNames = projects.map((t) => t.name);
     return await generateGraph(
       {
@@ -55,6 +60,7 @@ export async function runMany(
         all: nxArgs.all,
         targets: nxArgs.targets,
         projects: projectNames,
+        file,
       },
       projectNames
     );

diff --git a/packages/nx/src/command-line/run/run-one.ts b/packages/nx/src/command-line/run/run-one.ts
@@ -66,6 +66,11 @@ export async function runOne(
 
   if (nxArgs.graph) {
     const projectNames = projects.map((t) => t.name);
+    const file =
+      typeof nxArgs.graph === 'string' &&
+      (nxArgs.graph.endsWith('.json') || nxArgs.graph.endsWith('html'))
+        ? nxArgs.graph
+        : undefined;
 
     return await generateGraph(
       {
@@ -74,6 +79,7 @@ export async function runOne(
         view: 'tasks',
         targets: nxArgs.targets,
         projects: projectNames,
+        file,
       },
       projectNames
     );

diff --git a/packages/nx/src/command-line/yargs-utils/shared-options.ts b/packages/nx/src/command-line/yargs-utils/shared-options.ts
@@ -29,8 +29,9 @@ export function withRunOptions(yargs: Argv): Argv {
       hidden: true,
     })
     .option('graph', {
-      type: 'boolean',
-      describe: 'Show the task graph of the command',
+      type: 'string',
+      describe:
+        'Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser.',
       default: false,
     })
     .option('verbose', {

diff --git a/packages/nx/src/utils/command-line-utils.ts b/packages/nx/src/utils/command-line-utils.ts
@@ -29,7 +29,7 @@ export interface NxArgs {
   plain?: boolean;
   projects?: string[];
   select?: string;
-  graph?: boolean;
+  graph?: string | boolean;
   skipNxCache?: boolean;
   outputStyle?: string;
   nxBail?: boolean;
@@ -81,6 +81,15 @@ export function splitArgsIntoNxArgsAndOverrides(
   delete (nxArgs as any).$0;
   delete (nxArgs as any).__overrides_unparsed__;
 
+  if (!(nxArgs.graph === null || nxArgs.graph === undefined)) {
+    nxArgs.graph =
+      nxArgs.graph === 'true' || nxArgs.graph === true
+        ? true
+        : nxArgs.graph === 'false' || nxArgs.graph === false
+        ? false
+        : nxArgs.graph;
+  }
+
   if (mode === 'run-many') {
     const args = nxArgs as any;
     if (!args.projects) {