feat(nx-plugin): add "optional" flag to plugin configuration

nrwl · May 2, 2024 · 803c297 · 803c297
1 parent 5ded713
commit 803c297
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 4 deletions.
diff --git a/packages/nx/src/config/nx-json.ts b/packages/nx/src/config/nx-json.ts
@@ -443,6 +443,7 @@ export type ExpandedPluginConfiguration<T = unknown> = {
   options?: T;
   include?: string[];
   exclude?: string[];
+  optional?: boolean;
 };
 
 export function readNxJson(root: string = workspaceRoot): NxJsonConfiguration {

diff --git a/packages/nx/src/daemon/server/plugins.ts b/packages/nx/src/daemon/server/plugins.ts
@@ -18,7 +18,7 @@ export async function getPlugins() {
     workspaceRoot
   );
   cleanup = cleanupFn;
-  return result;
+  return result.filter(Boolean);
 }
 
 export function cleanupPlugins() {

diff --git a/packages/nx/src/project-graph/plugins/internal-api.ts b/packages/nx/src/project-graph/plugins/internal-api.ts
@@ -99,7 +99,7 @@ export const nxPluginCache: Map<
 export async function loadNxPlugins(
   plugins: PluginConfiguration[],
   root = workspaceRoot
-): Promise<[LoadedNxPlugin[], () => void]> {
+): Promise<[Array<LoadedNxPlugin | undefined>, () => void]> {
   const result: Promise<LoadedNxPlugin>[] = [];
 
   const loadingMethod =

diff --git a/packages/nx/src/project-graph/plugins/loader.ts b/packages/nx/src/project-graph/plugins/loader.ts
@@ -27,7 +27,7 @@ import { extname } from 'node:path';
 import { NxPlugin } from './public-api';
 import { PluginConfiguration } from '../../config/nx-json';
 import { retrieveProjectConfigurationsWithoutPluginInference } from '../utils/retrieve-workspace-files';
-import { normalizeNxPlugin } from './utils';
+import { isNxPluginOptional, normalizeNxPlugin } from './utils';
 import { LoadedNxPlugin } from './internal-api';
 import { LoadPluginError } from '../error-types';
 import path = require('node:path/posix');
@@ -251,7 +251,7 @@ export async function loadNxPluginAsync(
   pluginConfiguration: PluginConfiguration,
   paths: string[],
   root: string
-): Promise<LoadedNxPlugin> {
+): Promise<LoadedNxPlugin | undefined> {
   const moduleName =
     typeof pluginConfiguration === 'string'
       ? pluginConfiguration
@@ -282,6 +282,9 @@ export async function loadNxPluginAsync(
     );
     return new LoadedNxPlugin(plugin, pluginConfiguration);
   } catch (e) {
+    if (isNxPluginOptional(pluginConfiguration)) {
+      return undefined;
+    }
     throw new LoadPluginError(moduleName, e);
   }
 }

diff --git a/packages/nx/src/project-graph/plugins/utils.ts b/packages/nx/src/project-graph/plugins/utils.ts
@@ -2,6 +2,7 @@ import { dirname } from 'node:path';
 
 import { toProjectName } from '../../config/to-project-name';
 import { combineGlobPatterns } from '../../utils/globs';
+import { PluginConfiguration } from '../../config/nx-json';
 
 import type { NxPluginV1 } from '../../utils/nx-plugin.deprecated';
 import type {
@@ -100,3 +101,9 @@ export async function runCreateNodesInParallel(
   }
   return results;
 }
+
+export function isNxPluginOptional(pluginConfiguration: PluginConfiguration): boolean {
+  return typeof pluginConfiguration === 'string'
+    ? false
+    : pluginConfiguration.optional;
+}