nx 18.2.4 → 18.3.0-beta.1

package/src/{utils/nx-plugin.d.ts → project-graph/plugins/public-api.d.ts}

@@ -1,9 +1,8 @@
-import { FileMap, ProjectGraph, ProjectGraphExternalNode } from '../config/project-graph';
-import { PackageJson } from './package-json';
-import { ProjectConfiguration } from '../config/workspace-json-project-json';
-import { NxJsonConfiguration, PluginConfiguration } from '../config/nx-json';
-import { NxPluginV1 } from './nx-plugin.deprecated';
-import { RawProjectGraphDependency } from '../project-graph/project-graph-builder';
+import { NxPluginV1 } from '../../utils/nx-plugin.deprecated';
+import { FileMap, ProjectGraph, ProjectGraphExternalNode } from '../../config/project-graph';
+import { ProjectConfiguration } from '../../config/workspace-json-project-json';
+import { NxJsonConfiguration } from '../../config/nx-json';
+import { RawProjectGraphDependency } from '../project-graph-builder';
 /**
  * Context for {@link CreateNodesFunction}
  */
@@ -20,6 +19,7 @@ export interface CreateNodesContext {
  * Used for creating nodes for the {@link ProjectGraph}
  */
 export type CreateNodesFunction<T = unknown> = (projectConfigurationFile: string, options: T | undefined, context: CreateNodesContext) => CreateNodesResult | Promise<CreateNodesResult>;
+export type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 export interface CreateNodesResult {
     /**
      * A map of project root -> project configuration
@@ -34,7 +34,7 @@ export interface CreateNodesResult {
  * A pair of file patterns and {@link CreateNodesFunction}
  */
 export type CreateNodes<T = unknown> = readonly [
-    configFilePattern: string,
+    projectFilePattern: string,
     createNodesFunction: CreateNodesFunction<T>
 ];
 /**
@@ -77,49 +77,13 @@ export type NxPluginV2<TOptions = unknown> = {
      * Provides a file pattern and function that retrieves configuration info from
      * those files. e.g. { '**\/*.csproj': buildProjectsFromCsProjFile }
      */
-    createNodes?: CreateNodes;
+    createNodes?: CreateNodes<TOptions>;
     /**
      * Provides a function to analyze files to create dependencies for the {@link ProjectGraph}
      */
     createDependencies?: CreateDependencies<TOptions>;
 };
-export * from './nx-plugin.deprecated';
 /**
  * A plugin for Nx
  */
 export type NxPlugin = NxPluginV1 | NxPluginV2;
-export type LoadedNxPlugin = {
-    plugin: NxPluginV2 & Pick<NxPluginV1, 'processProjectGraph'>;
-    options?: unknown;
-    include?: string[];
-    exclude?: string[];
-};
-export declare const nxPluginCache: Map<string, LoadedNxPlugin['plugin']>;
-export declare function getPluginPathAndName(moduleName: string, paths: string[], projects: Record<string, ProjectConfiguration>, root: string): {
-    pluginPath: string;
-    name: any;
-};
-export declare function loadNxPluginAsync(pluginConfiguration: PluginConfiguration, paths: string[], projects: Record<string, ProjectConfiguration>, root: string): Promise<LoadedNxPlugin>;
-export declare function loadNxPlugins(plugins: PluginConfiguration[], paths?: string[], root?: string, projects?: Record<string, ProjectConfiguration>): Promise<LoadedNxPlugin[]>;
-export declare function ensurePluginIsV2(plugin: NxPlugin): NxPluginV2;
-export declare function isNxPluginV2(plugin: NxPlugin): plugin is NxPluginV2;
-export declare function isNxPluginV1(plugin: NxPlugin): plugin is NxPluginV1;
-export declare function readPluginPackageJson(pluginName: string, projects: Record<string, ProjectConfiguration>, paths?: string[]): {
-    path: string;
-    json: PackageJson;
-};
-export declare function resolveLocalNxPlugin(importPath: string, nxJsonConfiguration: NxJsonConfiguration, projects: Record<string, ProjectConfiguration>, root?: string): {
-    path: string;
-    projectConfig: ProjectConfiguration;
-} | null;
-/**
- * Register swc-node or ts-node if they are not currently registered
- * with some default settings which work well for Nx plugins.
- */
-export declare function registerPluginTSTranspiler(): void;
-/**
- * Unregister the ts-node transpiler if it is registered
- */
-export declare function unregisterPluginTSTranspiler(): void;
-export declare function getDefaultPlugins(root: string): Promise<LoadedNxPlugin[]>;
-type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/src/project-graph/plugins/public-api.js

@@ -0,0 +1,4 @@
+"use strict";
+// This file represents the public API for plugins which live in nx.json's plugins array.
+// For methods to interact with plugins from within Nx, see `./internal-api.ts`.
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/project-graph/plugins/utils.d.ts

@@ -0,0 +1,7 @@
+import type { NxPluginV1 } from '../../utils/nx-plugin.deprecated';
+import type { CreateNodesResultWithContext, LoadedNxPlugin, NormalizedPlugin } from './internal-api';
+import type { CreateNodesContext, NxPlugin, NxPluginV2 } from './public-api';
+export declare function isNxPluginV2(plugin: NxPlugin): plugin is NxPluginV2;
+export declare function isNxPluginV1(plugin: NxPlugin | LoadedNxPlugin): plugin is NxPluginV1;
+export declare function normalizeNxPlugin(plugin: NxPlugin): NormalizedPlugin;
+export declare function runCreateNodesInParallel(configFiles: string[], plugin: NormalizedPlugin, options: unknown, context: CreateNodesContext): Promise<CreateNodesResultWithContext[]>;

package/src/project-graph/plugins/utils.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runCreateNodesInParallel = exports.normalizeNxPlugin = exports.isNxPluginV1 = exports.isNxPluginV2 = void 0;
+const node_path_1 = require("node:path");
+const workspaces_1 = require("../../config/workspaces");
+const globs_1 = require("../../utils/globs");
+const error_types_1 = require("../error-types");
+function isNxPluginV2(plugin) {
+    return 'createNodes' in plugin || 'createDependencies' in plugin;
+}
+exports.isNxPluginV2 = isNxPluginV2;
+function isNxPluginV1(plugin) {
+    return 'processProjectGraph' in plugin || 'projectFilePatterns' in plugin;
+}
+exports.isNxPluginV1 = isNxPluginV1;
+function normalizeNxPlugin(plugin) {
+    if (isNxPluginV2(plugin)) {
+        return plugin;
+    }
+    if (isNxPluginV1(plugin) && plugin.projectFilePatterns) {
+        return {
+            ...plugin,
+            createNodes: [
+                `*/**/${(0, globs_1.combineGlobPatterns)(plugin.projectFilePatterns)}`,
+                (configFilePath) => {
+                    const root = (0, node_path_1.dirname)(configFilePath);
+                    return {
+                        projects: {
+                            [root]: {
+                                name: (0, workspaces_1.toProjectName)(configFilePath),
+                                targets: plugin.registerProjectTargets?.(configFilePath),
+                            },
+                        },
+                    };
+                },
+            ],
+        };
+    }
+    return plugin;
+}
+exports.normalizeNxPlugin = normalizeNxPlugin;
+async function runCreateNodesInParallel(configFiles, plugin, options, context) {
+    performance.mark(`${plugin.name}:createNodes - start`);
+    const promises = configFiles.map((file) => {
+        performance.mark(`${plugin.name}:createNodes:${file} - start`);
+        // Result is either static or a promise, using Promise.resolve lets us
+        // handle both cases with same logic
+        const value = Promise.resolve(plugin.createNodes[1](file, options, context));
+        return value
+            .catch((e) => {
+            performance.mark(`${plugin.name}:createNodes:${file} - end`);
+            return new error_types_1.CreateNodesError({
+                error: e,
+                pluginName: plugin.name,
+                file,
+            });
+        })
+            .then((r) => {
+            performance.mark(`${plugin.name}:createNodes:${file} - end`);
+            performance.measure(`${plugin.name}:createNodes:${file}`, `${plugin.name}:createNodes:${file} - start`, `${plugin.name}:createNodes:${file} - end`);
+            return { ...r, pluginName: plugin.name, file };
+        });
+    });
+    const results = await Promise.all(promises).then((results) => {
+        performance.mark(`${plugin.name}:createNodes - end`);
+        performance.measure(`${plugin.name}:createNodes`, `${plugin.name}:createNodes - start`, `${plugin.name}:createNodes - end`);
+        return results;
+    });
+    const [errors, successful] = partition(results, (r) => r instanceof error_types_1.CreateNodesError);
+    if (errors.length > 0) {
+        throw new error_types_1.AggregateCreateNodesError(plugin.name, errors, successful);
+    }
+    return results;
+}
+exports.runCreateNodesInParallel = runCreateNodesInParallel;
+function partition(arr, test) {
+    const pass = [];
+    const fail = [];
+    for (const item of arr) {
+        if (test(item)) {
+            pass.push(item);
+        }
+        else {
+            fail.push(item);
+        }
+    }
+    return [pass, fail];
+}

package/src/project-graph/project-graph-builder.d.ts

@@ -2,7 +2,7 @@
  * Builder for adding nodes and dependencies to a {@link ProjectGraph}
  */
 import { DependencyType, FileMap, ProjectFileMap, ProjectGraph, ProjectGraphExternalNode, ProjectGraphProjectNode } from '../config/project-graph';
-import { CreateDependenciesContext } from '../utils/nx-plugin';
+import { CreateDependenciesContext } from './plugins';
 /**
  * A class which builds up a project graph
  * @deprecated The {@link ProjectGraphProcessor} has been deprecated. Use a {@link CreateNodes} and/or a {@link CreateDependencies} instead. This will be removed in Nx 19.

package/src/project-graph/project-graph.d.ts

@@ -1,7 +1,8 @@
 import { ProcessDependenciesError, ProcessProjectGraphError } from './build-project-graph';
 import { ProjectGraph } from '../config/project-graph';
 import { ProjectConfiguration, ProjectsConfigurations } from '../config/workspace-json-project-json';
-import { ConfigurationSourceMaps, CreateNodesError, MergeNodesError } from './utils/project-configuration-utils';
+import { ConfigurationSourceMaps } from './utils/project-configuration-utils';
+import { CreateNodesError, MergeNodesError } from './error-types';
 import { DaemonProjectGraphError } from '../daemon/daemon-project-graph-error';
 /**
  * Synchronously reads the latest cached copy of the workspace's ProjectGraph.
@@ -33,7 +34,7 @@ export declare class ProjectGraphError extends Error {
      */
     getPartialProjectGraph(): ProjectGraph;
     getPartialSourcemaps(): ConfigurationSourceMaps;
-    getErrors(): (ProcessDependenciesError | ProcessProjectGraphError | CreateNodesError)[];
+    getErrors(): (CreateNodesError | ProcessDependenciesError | ProcessProjectGraphError)[];
 }
 /**
  * Computes and returns a ProjectGraph.

package/src/project-graph/project-graph.js

@@ -14,8 +14,8 @@ const workspace_root_1 = require("../utils/workspace-root");
 const perf_hooks_1 = require("perf_hooks");
 const retrieve_workspace_files_1 = require("./utils/retrieve-workspace-files");
 const nx_json_1 = require("../config/nx-json");
-const nx_plugin_1 = require("../utils/nx-plugin");
-const project_configuration_utils_1 = require("./utils/project-configuration-utils");
+const error_types_1 = require("./error-types");
+const internal_api_1 = require("./plugins/internal-api");
 /**
  * Synchronously reads the latest cached copy of the workspace's ProjectGraph.
  * @throws {Error} if there is no cached ProjectGraph to read from
@@ -69,17 +69,17 @@ function readProjectsConfigurationFromProjectGraph(projectGraph) {
 }
 exports.readProjectsConfigurationFromProjectGraph = readProjectsConfigurationFromProjectGraph;
 async function buildProjectGraphAndSourceMapsWithoutDaemon() {
-    // Set this globally to allow plugins to know if they are being called from the project graph creation
     global.NX_GRAPH_CREATION = true;
     const nxJson = (0, nx_json_1.readNxJson)();
     perf_hooks_1.performance.mark('retrieve-project-configurations:start');
     let configurationResult;
     let projectConfigurationsError;
+    const [plugins, cleanup] = await (0, internal_api_1.loadNxPlugins)(nxJson.plugins);
     try {
-        configurationResult = await (0, retrieve_workspace_files_1.retrieveProjectConfigurations)(workspace_root_1.workspaceRoot, nxJson);
+        configurationResult = await (0, retrieve_workspace_files_1.retrieveProjectConfigurations)(plugins, workspace_root_1.workspaceRoot, nxJson);
     }
     catch (e) {
-        if (e instanceof project_configuration_utils_1.ProjectConfigurationsError) {
+        if (e instanceof error_types_1.ProjectConfigurationsError) {
             projectConfigurationsError = e;
             configurationResult = e.partialProjectConfigurationsResult;
         }
@@ -97,7 +97,7 @@ async function buildProjectGraphAndSourceMapsWithoutDaemon() {
     let createDependenciesError;
     let projectGraphResult;
     try {
-        projectGraphResult = await (0, build_project_graph_1.buildProjectGraphUsingProjectFileMap)(projects, externalNodes, fileMap, allWorkspaceFiles, rustReferences, cacheEnabled ? (0, nx_deps_cache_1.readFileMapCache)() : null);
+        projectGraphResult = await (0, build_project_graph_1.buildProjectGraphUsingProjectFileMap)(projects, externalNodes, fileMap, allWorkspaceFiles, rustReferences, cacheEnabled ? (0, nx_deps_cache_1.readFileMapCache)() : null, plugins);
     }
     catch (e) {
         if (e instanceof build_project_graph_1.CreateDependenciesError) {
@@ -111,9 +111,11 @@ async function buildProjectGraphAndSourceMapsWithoutDaemon() {
             throw e;
         }
     }
+    finally {
+        cleanup();
+    }
     const { projectGraph, projectFileMapCache } = projectGraphResult;
     perf_hooks_1.performance.mark('build-project-graph-using-project-file-map:end');
-    (0, nx_plugin_1.unregisterPluginTSTranspiler)();
     delete global.NX_GRAPH_CREATION;
     const errors = [
         ...(projectConfigurationsError?.errors ?? []),

package/src/project-graph/utils/normalize-project-nodes.d.ts

@@ -1,7 +1,7 @@
 import { ProjectGraphProjectNode } from '../../config/project-graph';
 import { ProjectGraphBuilder } from '../project-graph-builder';
 import { ProjectConfiguration, TargetConfiguration } from '../../config/workspace-json-project-json';
-import { CreateDependenciesContext } from '../../utils/nx-plugin';
+import { CreateDependenciesContext } from '../plugins';
 export declare function normalizeProjectNodes(ctx: CreateDependenciesContext, builder: ProjectGraphBuilder): Promise<void>;
 /**
  * Apply target defaults and normalization

package/src/project-graph/utils/project-configuration-utils.d.ts

@@ -1,8 +1,8 @@
 import { NxJsonConfiguration, TargetDefaults } from '../../config/nx-json';
 import { ProjectGraphExternalNode } from '../../config/project-graph';
 import { ProjectConfiguration, TargetConfiguration } from '../../config/workspace-json-project-json';
-import { LoadedNxPlugin } from '../../utils/nx-plugin';
-import { ONLY_MODIFIES_EXISTING_TARGET } from '../../plugins/target-defaults/target-defaults-plugin';
+import { ONLY_MODIFIES_EXISTING_TARGET } from '../../plugins/target-defaults/symbols';
+import { LoadedNxPlugin } from '../plugins/internal-api';
 export type SourceInformation = [file: string, plugin: string];
 export type ConfigurationSourceMaps = Record<string, Record<string, SourceInformation>>;
 export declare function mergeProjectConfigurationIntoRootMap(projectRootMap: Map<string, ProjectConfiguration>, project: ProjectConfiguration & {
@@ -24,32 +24,9 @@ export type ConfigurationResult = {
  * @param workspaceFiles A list of non-ignored workspace files
  * @param plugins The plugins that should be used to infer project configuration
  */
-export declare function createProjectConfigurations(root: string, nxJson: NxJsonConfiguration, workspaceFiles: string[], // making this parameter allows devkit to pick up newly created projects
+export declare function createProjectConfigurations(root: string, nxJson: NxJsonConfiguration, projectFiles: string[], // making this parameter allows devkit to pick up newly created projects
 plugins: LoadedNxPlugin[]): Promise<ConfigurationResult>;
 export declare function readProjectConfigurationsFromRootMap(projectRootMap: Map<string, ProjectConfiguration>): Record<string, ProjectConfiguration>;
-export declare class ProjectConfigurationsError extends Error {
-    readonly errors: Array<MergeNodesError | CreateNodesError>;
-    readonly partialProjectConfigurationsResult: ConfigurationResult;
-    constructor(errors: Array<MergeNodesError | CreateNodesError>, partialProjectConfigurationsResult: ConfigurationResult);
-}
-export declare class CreateNodesError extends Error {
-    file: string;
-    pluginName: string;
-    constructor({ file, pluginName, error, }: {
-        file: string;
-        pluginName: string;
-        error: Error;
-    });
-}
-export declare class MergeNodesError extends Error {
-    file: string;
-    pluginName: string;
-    constructor({ file, pluginName, error, }: {
-        file: string;
-        pluginName: string;
-        error: Error;
-    });
-}
 /**
  * Merges two targets.
  *