diff --git a/docs/generated/devkit/GraphJson.md b/docs/generated/devkit/GraphJson.md new file mode 100644 index 0000000000..349d669498 --- /dev/null +++ b/docs/generated/devkit/GraphJson.md @@ -0,0 +1,35 @@ +# Interface: GraphJson + +The data type that `nx graph --file graph.json` or `nx build --graph graph.json` contains + +## Table of contents + +### Properties + +- [graph](../../devkit/documents/GraphJson#graph): ProjectGraph +- [taskPlans](../../devkit/documents/GraphJson#taskplans): Record +- [tasks](../../devkit/documents/GraphJson#tasks): TaskGraph + +## Properties + +### graph + +• **graph**: [`ProjectGraph`](../../devkit/documents/ProjectGraph) + +The project graph + +--- + +### taskPlans + +• `Optional` **taskPlans**: `Record`\<`string`, `string`[]\> + +The plans for hashing a task in the task graph + +--- + +### tasks + +• `Optional` **tasks**: [`TaskGraph`](../../devkit/documents/TaskGraph) + +A graph of tasks populated with `nx build --graph` diff --git a/docs/generated/devkit/README.md b/docs/generated/devkit/README.md index 0b9bc52845..b3aff0c275 100644 --- a/docs/generated/devkit/README.md +++ b/docs/generated/devkit/README.md @@ -35,6 +35,7 @@ It only uses language primitives and immutable objects - [FileData](../../devkit/documents/FileData) - [FileMap](../../devkit/documents/FileMap) - [GeneratorsJson](../../devkit/documents/GeneratorsJson) +- [GraphJson](../../devkit/documents/GraphJson) - [Hash](../../devkit/documents/Hash) - [HasherContext](../../devkit/documents/HasherContext) - [ImplicitJsonSubsetDependency](../../devkit/documents/ImplicitJsonSubsetDependency) diff --git a/docs/generated/packages/devkit/documents/nx_devkit.md b/docs/generated/packages/devkit/documents/nx_devkit.md index 0b9bc52845..b3aff0c275 100644 --- a/docs/generated/packages/devkit/documents/nx_devkit.md +++ b/docs/generated/packages/devkit/documents/nx_devkit.md @@ -35,6 +35,7 @@ It only uses language primitives and immutable objects - [FileData](../../devkit/documents/FileData) - [FileMap](../../devkit/documents/FileMap) - [GeneratorsJson](../../devkit/documents/GeneratorsJson) +- [GraphJson](../../devkit/documents/GraphJson) - [Hash](../../devkit/documents/Hash) - [HasherContext](../../devkit/documents/HasherContext) - [ImplicitJsonSubsetDependency](../../devkit/documents/ImplicitJsonSubsetDependency) diff --git a/packages/nx/src/command-line/graph/graph.ts b/packages/nx/src/command-line/graph/graph.ts index 9f994085e2..ca8c4edda2 100644 --- a/packages/nx/src/command-line/graph/graph.ts +++ b/packages/nx/src/command-line/graph/graph.ts @@ -1155,9 +1155,21 @@ function expandInputs( }; } -interface GraphJsonResponse { +/** + * The data type that `nx graph --file graph.json` or `nx build --graph graph.json` contains + */ +export interface GraphJson { + /** + * A graph of tasks populated with `nx build --graph` + */ tasks?: TaskGraph; + /** + * The plans for hashing a task in the task graph + */ taskPlans?: Record; + /** + * The project graph + */ graph: ProjectGraph; } @@ -1166,8 +1178,8 @@ async function createJsonOutput( rawGraph: ProjectGraph, projects: string[], targets?: string[] -): Promise { - const response: GraphJsonResponse = { +): Promise { + const response: GraphJson = { graph: prunedGraph, }; diff --git a/packages/nx/src/devkit-exports.ts b/packages/nx/src/devkit-exports.ts index 3477936477..a51e64914f 100644 --- a/packages/nx/src/devkit-exports.ts +++ b/packages/nx/src/devkit-exports.ts @@ -159,6 +159,8 @@ export type { ProjectGraphProcessorContext, } from './config/project-graph'; +export type { GraphJson } from './command-line/graph/graph'; + /** * @category Project Graph */