fix(devkit): correct nx-json typing after plugin tweaks

nrwl · Oct 18, 2023 · 496cd86 · 496cd86
1 parent 472dbc3
commit 496cd86
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 6 deletions.
diff --git a/docs/generated/devkit/NxJsonConfiguration.md b/docs/generated/devkit/NxJsonConfiguration.md
@@ -198,7 +198,7 @@ Specifies how many tasks can be run in parallel.
 
 ### plugins
 
-• `Optional` **plugins**: `PluginDefinition`[]
+• `Optional` **plugins**: [`PluginDefinition`](../../devkit/documents/PluginDefinition)[]
 
 Plugins for extending the project graph
 

diff --git a/docs/generated/devkit/PluginDefinition.md b/docs/generated/devkit/PluginDefinition.md
@@ -0,0 +1,3 @@
+# Type alias: PluginDefinition
+
+Ƭ **PluginDefinition**: `string` \| { `options?`: `unknown` ; `plugin`: `string` }
diff --git a/docs/generated/devkit/README.md b/docs/generated/devkit/README.md
@@ -77,6 +77,7 @@ It only uses language primitives and immutable objects
 - [NxPluginV1](../../devkit/documents/NxPluginV1)
 - [NxPluginV2](../../devkit/documents/NxPluginV2)
 - [PackageManager](../../devkit/documents/PackageManager)
+- [PluginDefinition](../../devkit/documents/PluginDefinition)
 - [ProjectGraphNode](../../devkit/documents/ProjectGraphNode)
 - [ProjectTargetConfigurator](../../devkit/documents/ProjectTargetConfigurator)
 - [ProjectType](../../devkit/documents/ProjectType)

diff --git a/docs/generated/devkit/Workspace.md b/docs/generated/devkit/Workspace.md
@@ -254,7 +254,7 @@ Specifies how many tasks can be run in parallel.
 
 ### plugins
 
-• `Optional` **plugins**: `PluginDefinition`[]
+• `Optional` **plugins**: [`PluginDefinition`](../../devkit/documents/PluginDefinition)[]
 
 Plugins for extending the project graph
 

diff --git a/docs/generated/packages/devkit/documents/nx_devkit.md b/docs/generated/packages/devkit/documents/nx_devkit.md
@@ -77,6 +77,7 @@ It only uses language primitives and immutable objects
 - [NxPluginV1](../../devkit/documents/NxPluginV1)
 - [NxPluginV2](../../devkit/documents/NxPluginV2)
 - [PackageManager](../../devkit/documents/PackageManager)
+- [PluginDefinition](../../devkit/documents/PluginDefinition)
 - [ProjectGraphNode](../../devkit/documents/ProjectGraphNode)
 - [ProjectTargetConfigurator](../../devkit/documents/ProjectTargetConfigurator)
 - [ProjectType](../../devkit/documents/ProjectType)

diff --git a/packages/nx/src/config/nx-json.ts b/packages/nx/src/config/nx-json.ts
@@ -225,9 +225,7 @@ export interface NxJsonConfiguration<T = '*' | string[]> {
   useDaemonProcess?: boolean;
 }
 
-export type PluginDefinition =
-  | string
-  | { plugin: string; options?: Record<string, unknown> };
+export type PluginDefinition = string | { plugin: string; options?: unknown };
 
 export function readNxJson(root: string = workspaceRoot): NxJsonConfiguration {
   const nxJson = join(root, 'nx.json');

diff --git a/packages/nx/src/devkit-exports.ts b/packages/nx/src/devkit-exports.ts
@@ -69,6 +69,7 @@ export type {
   ImplicitDependencyEntry,
   ImplicitJsonSubsetDependency,
   NxJsonConfiguration,
+  PluginDefinition,
   TargetDefaults,
   NxAffectedConfig,
 } from './config/nx-json';

diff --git a/packages/nx/src/project-graph/nx-deps-cache.ts b/packages/nx/src/project-graph/nx-deps-cache.ts
@@ -328,7 +328,7 @@ function processProjectNode(
 type PluginData = {
   name: string;
   version: string;
-  options?: Record<string, unknown>;
+  options?: unknown;
 };
 
 function getNxJsonPluginsData(
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Type alias: PluginDefinition

		Ƭ PluginDefinition: `string` \\| { `options?`: `unknown` ; `plugin`: `string` }