@nx/devkit 19.1.1 → 19.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/devkit",
-  "version": "19.1.1",
+  "version": "19.1.2",
   "private": false,
   "description": "The Nx Devkit is used to customize Nx for different technologies and use cases. It contains many utility functions for reading and writing files, updating configuration, working with Abstract Syntax Trees(ASTs), and more. Learn more about [extending Nx by leveraging the Nx Devkit](https://nx.dev/extending-nx/intro/getting-started) on our docs.",
   "repository": {
@@ -36,7 +36,7 @@
     "semver": "^7.5.3",
     "yargs-parser": "21.1.1",
     "minimatch": "9.0.3",
-    "@nrwl/devkit": "19.1.1"
+    "@nrwl/devkit": "19.1.2"
   },
   "peerDependencies": {
     "nx": ">= 17 <= 20"

package/src/generators/plugin-migrations/executor-to-plugin-migrator.d.ts

@@ -1,9 +1,9 @@
 import { ProjectGraph, TargetConfiguration, Tree, CreateNodes } from 'nx/src/devkit-exports';
 type PluginOptionsBuilder<T> = (targetName: string) => T;
-type PostTargetTransformer = (targetConfiguration: TargetConfiguration, tree?: Tree, projectDetails?: {
+type PostTargetTransformer = (targetConfiguration: TargetConfiguration, tree: Tree, projectDetails: {
     projectName: string;
     root: string;
-}) => TargetConfiguration;
+}, inferredTargetConfiguration: TargetConfiguration) => TargetConfiguration;
 type SkipTargetFilter = (targetConfiguration: TargetConfiguration) => [boolean, string];
 export declare function migrateExecutorToPlugin<T>(tree: Tree, projectGraph: ProjectGraph, executor: string, pluginPath: string, pluginOptionsBuilder: PluginOptionsBuilder<T>, postTargetTransformer: PostTargetTransformer, createNodes: CreateNodes<T>, specificProjectToMigrate?: string, skipTargetFilter?: SkipTargetFilter): Promise<Map<string, Set<string>>>;
 export {};

package/src/generators/plugin-migrations/executor-to-plugin-migrator.js

@@ -1,9 +1,10 @@
 "use strict";
-var _ExecutorToPluginMigrator_instances, _ExecutorToPluginMigrator_projectGraph, _ExecutorToPluginMigrator_executor, _ExecutorToPluginMigrator_pluginPath, _ExecutorToPluginMigrator_pluginOptionsBuilder, _ExecutorToPluginMigrator_postTargetTransformer, _ExecutorToPluginMigrator_skipTargetFilter, _ExecutorToPluginMigrator_specificProjectToMigrate, _ExecutorToPluginMigrator_nxJson, _ExecutorToPluginMigrator_targetDefaultsForExecutor, _ExecutorToPluginMigrator_targetAndProjectsToMigrate, _ExecutorToPluginMigrator_pluginToAddForTarget, _ExecutorToPluginMigrator_createNodes, _ExecutorToPluginMigrator_configFiles, _ExecutorToPluginMigrator_createNodesResultsForTargets, _ExecutorToPluginMigrator_init, _ExecutorToPluginMigrator_migrateTarget, _ExecutorToPluginMigrator_migrateProject, _ExecutorToPluginMigrator_pluginRequiresIncludes, _ExecutorToPluginMigrator_addPlugins, _ExecutorToPluginMigrator_getTargetAndProjectsToMigrate, _ExecutorToPluginMigrator_getTargetDefaultsForExecutor, _ExecutorToPluginMigrator_getCreatedTargetForProjectRoot, _ExecutorToPluginMigrator_getCreateNodesResults;
+var _ExecutorToPluginMigrator_instances, _ExecutorToPluginMigrator_projectGraph, _ExecutorToPluginMigrator_executor, _ExecutorToPluginMigrator_pluginPath, _ExecutorToPluginMigrator_pluginOptionsBuilder, _ExecutorToPluginMigrator_postTargetTransformer, _ExecutorToPluginMigrator_skipTargetFilter, _ExecutorToPluginMigrator_specificProjectToMigrate, _ExecutorToPluginMigrator_nxJson, _ExecutorToPluginMigrator_targetDefaultsForExecutor, _ExecutorToPluginMigrator_targetAndProjectsToMigrate, _ExecutorToPluginMigrator_pluginToAddForTarget, _ExecutorToPluginMigrator_createNodes, _ExecutorToPluginMigrator_configFiles, _ExecutorToPluginMigrator_createNodesResultsForTargets, _ExecutorToPluginMigrator_init, _ExecutorToPluginMigrator_migrateTarget, _ExecutorToPluginMigrator_migrateProject, _ExecutorToPluginMigrator_mergeInputs, _ExecutorToPluginMigrator_pluginRequiresIncludes, _ExecutorToPluginMigrator_addPlugins, _ExecutorToPluginMigrator_getTargetAndProjectsToMigrate, _ExecutorToPluginMigrator_getTargetDefaultsForExecutor, _ExecutorToPluginMigrator_getCreatedTargetForProjectRoot, _ExecutorToPluginMigrator_getCreateNodesResults;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.migrateExecutorToPlugin = void 0;
 const tslib_1 = require("tslib");
 const minimatch_1 = require("minimatch");
+const node_assert_1 = require("node:assert");
 const executor_options_utils_1 = require("../executor-options-utils");
 const plugin_migration_utils_1 = require("./plugin-migration-utils");
 const devkit_exports_1 = require("nx/src/devkit-exports");
@@ -74,10 +75,10 @@ _ExecutorToPluginMigrator_projectGraph = new WeakMap(), _ExecutorToPluginMigrato
     projectTarget = (0, devkit_internals_1.mergeTargetConfigurations)(projectTarget, tslib_1.__classPrivateFieldGet(this, _ExecutorToPluginMigrator_targetDefaultsForExecutor, "f"));
     delete projectTarget.executor;
     (0, plugin_migration_utils_1.deleteMatchingProperties)(projectTarget, createdTarget);
-    projectTarget = tslib_1.__classPrivateFieldGet(this, _ExecutorToPluginMigrator_postTargetTransformer, "f").call(this, projectTarget, this.tree, {
-        projectName,
-        root: projectFromGraph.data.root,
-    });
+    if (projectTarget.inputs && createdTarget.inputs) {
+        tslib_1.__classPrivateFieldGet(this, _ExecutorToPluginMigrator_instances, "m", _ExecutorToPluginMigrator_mergeInputs).call(this, projectTarget, createdTarget);
+    }
+    projectTarget = tslib_1.__classPrivateFieldGet(this, _ExecutorToPluginMigrator_postTargetTransformer, "f").call(this, projectTarget, this.tree, { projectName, root: projectFromGraph.data.root }, createdTarget);
     if (projectTarget.options &&
         Object.keys(projectTarget.options).length === 0) {
         delete projectTarget.options;
@@ -93,6 +94,41 @@ _ExecutorToPluginMigrator_projectGraph = new WeakMap(), _ExecutorToPluginMigrato
     }
     (0, devkit_exports_1.updateProjectConfiguration)(this.tree, projectName, projectConfig);
     return `${projectFromGraph.data.root}/**/*`;
+}, _ExecutorToPluginMigrator_mergeInputs = function _ExecutorToPluginMigrator_mergeInputs(target, inferredTarget) {
+    const isInputInferred = (input) => {
+        return inferredTarget.inputs.some((inferredInput) => {
+            try {
+                (0, node_assert_1.deepStrictEqual)(input, inferredInput);
+                return true;
+            }
+            catch {
+                return false;
+            }
+        });
+    };
+    if (target.inputs.every(isInputInferred)) {
+        delete target.inputs;
+        return;
+    }
+    const inferredTargetExternalDependencyInput = inferredTarget.inputs.find((i) => typeof i !== 'string' && 'externalDependencies' in i);
+    if (!inferredTargetExternalDependencyInput) {
+        // plugins should normally have an externalDependencies input, but if it
+        // doesn't, there's nothing to merge
+        return;
+    }
+    const targetExternalDependencyInput = target.inputs.find((i) => typeof i !== 'string' && 'externalDependencies' in i);
+    if (!targetExternalDependencyInput) {
+        // the target doesn't have an externalDependencies input, so we can just
+        // add the inferred one
+        target.inputs.push(inferredTargetExternalDependencyInput);
+    }
+    else {
+        // the target has an externalDependencies input, so we need to merge them
+        targetExternalDependencyInput.externalDependencies = Array.from(new Set([
+            ...targetExternalDependencyInput.externalDependencies,
+            ...inferredTargetExternalDependencyInput.externalDependencies,
+        ]));
+    }
 }, _ExecutorToPluginMigrator_pluginRequiresIncludes = async function _ExecutorToPluginMigrator_pluginRequiresIncludes(targetName, plugin) {
     const loadedPlugin = new devkit_internals_1.LoadedNxPlugin({
         createNodes: tslib_1.__classPrivateFieldGet(this, _ExecutorToPluginMigrator_createNodes, "f"),
@@ -174,7 +210,7 @@ _ExecutorToPluginMigrator_projectGraph = new WeakMap(), _ExecutorToPluginMigrato
         }
     });
 }, _ExecutorToPluginMigrator_getTargetDefaultsForExecutor = function _ExecutorToPluginMigrator_getTargetDefaultsForExecutor() {
-    tslib_1.__classPrivateFieldSet(this, _ExecutorToPluginMigrator_targetDefaultsForExecutor, tslib_1.__classPrivateFieldGet(this, _ExecutorToPluginMigrator_nxJson, "f").targetDefaults?.[tslib_1.__classPrivateFieldGet(this, _ExecutorToPluginMigrator_executor, "f")], "f");
+    tslib_1.__classPrivateFieldSet(this, _ExecutorToPluginMigrator_targetDefaultsForExecutor, structuredClone(tslib_1.__classPrivateFieldGet(this, _ExecutorToPluginMigrator_nxJson, "f").targetDefaults?.[tslib_1.__classPrivateFieldGet(this, _ExecutorToPluginMigrator_executor, "f")]), "f");
 }, _ExecutorToPluginMigrator_getCreatedTargetForProjectRoot = function _ExecutorToPluginMigrator_getCreatedTargetForProjectRoot(targetName, projectRoot) {
     const entry = Object.entries(tslib_1.__classPrivateFieldGet(this, _ExecutorToPluginMigrator_createNodesResultsForTargets, "f").get(targetName)?.projects ?? {}).find(([root]) => root === projectRoot);
     if (!entry) {

package/src/generators/plugin-migrations/plugin-migration-utils.d.ts

@@ -1,3 +1,4 @@
+import type { TargetConfiguration } from 'nx/src/devkit-exports';
 /**
  * Iterate through the current target in the project.json and its options comparing it to the target created by the Plugin itself
  * Delete matching properties from current target.
@@ -52,3 +53,10 @@
  * @param createdTarget The target created by the Plugin
  */
 export declare function deleteMatchingProperties(targetToMigrate: object, createdTarget: object): void;
+export declare function processTargetOutputs(target: TargetConfiguration, renamedOutputOptions: Array<{
+    newName: string;
+    oldName: string;
+}>, inferredTarget: TargetConfiguration, projectDetails: {
+    projectName: string;
+    projectRoot: string;
+}): void;

package/src/generators/plugin-migrations/plugin-migration-utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteMatchingProperties = void 0;
+exports.processTargetOutputs = exports.deleteMatchingProperties = void 0;
+const devkit_internals_1 = require("nx/src/devkit-internals");
 /**
  * Iterate through the current target in the project.json and its options comparing it to the target created by the Plugin itself
  * Delete matching properties from current target.
@@ -76,3 +77,67 @@ function deleteMatchingProperties(targetToMigrate, createdTarget) {
     }
 }
 exports.deleteMatchingProperties = deleteMatchingProperties;
+function processTargetOutputs(target, renamedOutputOptions, inferredTarget, projectDetails) {
+    const interpolatedInferredOutputs = (inferredTarget.outputs ?? []).map((output) => (0, devkit_internals_1.interpolate)(output, {
+        workspaceRoot: '',
+        projectRoot: projectDetails.projectRoot,
+        projectName: projectDetails.projectName,
+    }));
+    const targetOutputs = (target.outputs ?? []).map((output) => updateOutput(output, renamedOutputOptions));
+    const interpolatedOutputs = targetOutputs.map((output) => (0, devkit_internals_1.interpolate)(output, {
+        workspaceRoot: '',
+        projectRoot: projectDetails.projectRoot,
+        projectName: projectDetails.projectName,
+    }));
+    const shouldDelete = interpolatedOutputs.every((output) => interpolatedInferredOutputs.includes(output));
+    if (shouldDelete) {
+        // all existing outputs are already inferred
+        delete target.outputs;
+        return;
+    }
+    // move extra inferred outputs to the target outputs
+    for (let i = 0; i < interpolatedInferredOutputs.length; i++) {
+        if (!interpolatedOutputs.includes(interpolatedInferredOutputs[i])) {
+            targetOutputs.push(inferredTarget.outputs[i]);
+            interpolatedOutputs.push(interpolatedInferredOutputs[i]);
+        }
+    }
+    target.outputs = targetOutputs;
+}
+exports.processTargetOutputs = processTargetOutputs;
+function updateOutputRenamingOption(output, option, previousName) {
+    const newOptionToken = `{options.${option}}`;
+    const oldOptionToken = `{options.${previousName}}`;
+    if (!output.startsWith('{workspaceRoot}') &&
+        !output.startsWith('{projectRoot}')) {
+        return `{projectRoot}/${output.replace(oldOptionToken, newOptionToken)}`;
+    }
+    if (output.startsWith('{workspaceRoot}') &&
+        !output.startsWith('{workspaceRoot}/{projectRoot}')) {
+        return output
+            .replace('{workspaceRoot}', '{projectRoot}')
+            .replace(oldOptionToken, newOptionToken);
+    }
+    return output.replace(oldOptionToken, newOptionToken);
+}
+function updateOutput(output, renamedOutputOptions) {
+    if (!/{options\..*}/.test(output)) {
+        // output does not contain any option tokens
+        return output;
+    }
+    for (const { newName, oldName } of renamedOutputOptions) {
+        const optionToken = `{options.${oldName}}`;
+        if (output.includes(optionToken)) {
+            return updateOutputRenamingOption(output, newName, oldName);
+        }
+    }
+    if (!output.startsWith('{workspaceRoot}') &&
+        !output.startsWith('{projectRoot}')) {
+        return `{projectRoot}/${output}`;
+    }
+    if (output.startsWith('{workspaceRoot}') &&
+        !output.startsWith('{workspaceRoot}/{projectRoot}')) {
+        return output.replace('{workspaceRoot}', '{projectRoot}');
+    }
+    return output;
+}