nx 24.0.0-beta.2 → 24.0.0-beta.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (158) hide show
  1. package/dist/bin/post-install.js +5 -3
  2. package/dist/src/adapter/ngcli-adapter.js +1 -2
  3. package/dist/src/command-line/add/add.d.ts +2 -0
  4. package/dist/src/command-line/add/add.js +23 -5
  5. package/dist/src/command-line/affected/affected.js +2 -2
  6. package/dist/src/command-line/init/implementation/add-nx-to-nest.js +21 -62
  7. package/dist/src/command-line/migrate/agentic/definitions.d.ts +1 -3
  8. package/dist/src/command-line/migrate/agentic/definitions.js +5 -97
  9. package/dist/src/command-line/migrate/agentic/handoff-gitignore.d.ts +7 -41
  10. package/dist/src/command-line/migrate/agentic/handoff-gitignore.js +9 -48
  11. package/dist/src/command-line/migrate/agentic/handoff.d.ts +1 -43
  12. package/dist/src/command-line/migrate/agentic/handoff.js +3 -119
  13. package/dist/src/command-line/migrate/agentic/instruction-files.d.ts +0 -21
  14. package/dist/src/command-line/migrate/agentic/instruction-files.js +6 -27
  15. package/dist/src/command-line/migrate/agentic/master/run-master-session.d.ts +19 -1
  16. package/dist/src/command-line/migrate/agentic/master/run-master-session.js +63 -36
  17. package/dist/src/command-line/migrate/agentic/master/spawn-master.d.ts +1 -0
  18. package/dist/src/command-line/migrate/agentic/master/spawn-master.js +7 -5
  19. package/dist/src/command-line/migrate/agentic/print-dropped-agent-context.d.ts +2 -2
  20. package/dist/src/command-line/migrate/agentic/print-dropped-agent-context.js +2 -2
  21. package/dist/src/command-line/migrate/agentic/prompts/fragments.d.ts +1 -12
  22. package/dist/src/command-line/migrate/agentic/prompts/fragments.js +8 -17
  23. package/dist/src/command-line/migrate/agentic/prompts/shared-rendering.d.ts +0 -15
  24. package/dist/src/command-line/migrate/agentic/prompts/shared-rendering.js +3 -100
  25. package/dist/src/command-line/migrate/agentic/select.d.ts +12 -6
  26. package/dist/src/command-line/migrate/agentic/select.js +35 -5
  27. package/dist/src/command-line/migrate/agentic/types.d.ts +9 -68
  28. package/dist/src/command-line/migrate/agentic/types.js +5 -5
  29. package/dist/src/command-line/migrate/command-object.js +3 -3
  30. package/dist/src/command-line/migrate/execute-migration.d.ts +4 -4
  31. package/dist/src/command-line/migrate/execute-migration.js +7 -5
  32. package/dist/src/command-line/migrate/migrate-analytics.d.ts +12 -1
  33. package/dist/src/command-line/migrate/migrate-analytics.js +26 -0
  34. package/dist/src/command-line/migrate/migrate-commits.d.ts +9 -10
  35. package/dist/src/command-line/migrate/migrate-commits.js +25 -18
  36. package/dist/src/command-line/migrate/migrate-output.d.ts +1 -6
  37. package/dist/src/command-line/migrate/migrate-output.js +1 -10
  38. package/dist/src/command-line/migrate/migrate.d.ts +3 -0
  39. package/dist/src/command-line/migrate/migrate.js +77 -44
  40. package/dist/src/command-line/migrate/run/agent-output.d.ts +1 -0
  41. package/dist/src/command-line/migrate/run/agent-output.js +4 -0
  42. package/dist/src/command-line/migrate/run/broker.js +1 -1
  43. package/dist/src/command-line/migrate/run/give-up.d.ts +4 -3
  44. package/dist/src/command-line/migrate/run/give-up.js +8 -5
  45. package/dist/src/command-line/migrate/run/index.d.ts +2 -1
  46. package/dist/src/command-line/migrate/run/index.js +5 -1
  47. package/dist/src/command-line/migrate/run/issues.js +7 -2
  48. package/dist/src/command-line/migrate/run/orchestrator.d.ts +40 -4
  49. package/dist/src/command-line/migrate/run/orchestrator.js +233 -92
  50. package/dist/src/command-line/migrate/run/run-state.d.ts +4 -1
  51. package/dist/src/command-line/migrate/run/run-state.js +20 -2
  52. package/dist/src/command-line/migrate/run/runbook.d.ts +1 -0
  53. package/dist/src/command-line/migrate/run/runbook.js +99 -21
  54. package/dist/src/command-line/migrate/run/state-lock.d.ts +29 -4
  55. package/dist/src/command-line/migrate/run/state-lock.js +102 -10
  56. package/dist/src/command-line/migrate/run/util.d.ts +4 -2
  57. package/dist/src/command-line/migrate/run/util.js +23 -2
  58. package/dist/src/command-line/migrate/run/worker.d.ts +1 -1
  59. package/dist/src/command-line/migrate/run/worker.js +252 -250
  60. package/dist/src/command-line/release/changelog.js +9 -6
  61. package/dist/src/command-line/release/config/config.d.ts +1 -0
  62. package/dist/src/command-line/release/config/config.js +48 -9
  63. package/dist/src/command-line/release/release.js +2 -2
  64. package/dist/src/command-line/release/utils/git.js +8 -7
  65. package/dist/src/command-line/release/utils/interpolate-release-config.d.ts +6 -0
  66. package/dist/src/command-line/release/utils/interpolate-release-config.js +39 -0
  67. package/dist/src/command-line/release/utils/release-graph.d.ts +5 -0
  68. package/dist/src/command-line/release/utils/release-graph.js +1 -0
  69. package/dist/src/command-line/release/utils/resolve-changelog-renderer.js +2 -2
  70. package/dist/src/command-line/release/utils/shared.js +10 -10
  71. package/dist/src/command-line/release/utils/version-plan-utils.d.ts +3 -12
  72. package/dist/src/command-line/release/utils/version-plan-utils.js +33 -55
  73. package/dist/src/command-line/release/version/version-actions.js +2 -1
  74. package/dist/src/command-line/release/version.js +5 -2
  75. package/dist/src/command-line/show/projects.js +5 -3
  76. package/dist/src/command-line/yargs-utils/shared-options.js +1 -1
  77. package/dist/src/config/misc-interfaces.d.ts +6 -0
  78. package/dist/src/config/nx-json.d.ts +8 -5
  79. package/dist/src/config/workspace-json-project-json.d.ts +23 -12
  80. package/dist/src/core/graph/main.js +1 -1
  81. package/dist/src/core/graph/runtime.js +1 -1
  82. package/dist/src/core/graph/styles.css +1 -1
  83. package/dist/src/core/graph/styles.js +1 -1
  84. package/dist/src/devkit-exports.d.ts +8 -0
  85. package/dist/src/devkit-exports.js +12 -1
  86. package/dist/src/devkit-internals.d.ts +2 -1
  87. package/dist/src/devkit-internals.js +7 -3
  88. package/dist/src/executors/run-commands/run-commands.impl.d.ts +2 -2
  89. package/dist/src/executors/run-commands/run-commands.impl.js +20 -10
  90. package/dist/src/executors/run-commands/running-tasks.d.ts +12 -3
  91. package/dist/src/executors/run-commands/running-tasks.js +22 -18
  92. package/dist/src/hasher/check-task-files.js +1 -4
  93. package/dist/src/migrations/update-23-2-0/set-cache-on-executor-target-defaults.d.ts +1 -2
  94. package/dist/src/migrations/update-23-2-0/set-cache-on-executor-target-defaults.js +6 -11
  95. package/dist/src/migrations/update-23-2-0/set-cache-on-executor-target-defaults.md +2 -2
  96. package/dist/src/migrations/update-24-0-0/enable-legacy-affected.d.ts +4 -0
  97. package/dist/src/migrations/update-24-0-0/enable-legacy-affected.js +15 -0
  98. package/dist/src/migrations/update-24-0-0/enable-legacy-affected.md +30 -0
  99. package/dist/src/migrations/update-24-0-0/move-custom-hashers-to-inputs.md +7 -6
  100. package/dist/src/migrations/update-24-0-0/rename-ultracache-ignore-options.d.ts +3 -0
  101. package/dist/src/migrations/update-24-0-0/rename-ultracache-ignore-options.js +130 -0
  102. package/dist/src/migrations/update-24-0-0/rename-ultracache-ignore-options.md +62 -0
  103. package/dist/src/native/index.d.ts +11 -5
  104. package/dist/src/native/nx.wasm32-wasi.debug.wasm +0 -0
  105. package/dist/src/native/nx.wasm32-wasi.wasm +0 -0
  106. package/dist/src/plugins/js/lock-file/pnpm-parser.js +1 -3
  107. package/dist/src/plugins/js/lock-file/pruned-output.d.ts +2 -2
  108. package/dist/src/plugins/js/lock-file/pruned-output.js +4 -4
  109. package/dist/src/project-graph/affected/affected-tasks.d.ts +6 -5
  110. package/dist/src/project-graph/affected/affected-tasks.js +16 -6
  111. package/dist/src/project-graph/plugins/loaded-nx-plugin.js +49 -6
  112. package/dist/src/project-graph/utils/project-configuration/target-merging.js +1 -1
  113. package/dist/src/project-graph/utils/project-configuration/target-normalization.js +7 -133
  114. package/dist/src/project-graph/utils/project-configuration-utils.js +2 -2
  115. package/dist/src/tasks-runner/pseudo-ipc.d.ts +1 -0
  116. package/dist/src/tasks-runner/pseudo-ipc.js +4 -0
  117. package/dist/src/tasks-runner/readiness/probes.d.ts +6 -1
  118. package/dist/src/tasks-runner/readiness/probes.js +41 -2
  119. package/dist/src/tasks-runner/readiness/ready-signal-server.d.ts +18 -0
  120. package/dist/src/tasks-runner/readiness/ready-signal-server.js +71 -0
  121. package/dist/src/tasks-runner/readiness/ready-signal.d.ts +25 -0
  122. package/dist/src/tasks-runner/readiness/ready-signal.js +70 -0
  123. package/dist/src/tasks-runner/readiness/ready-when.d.ts +35 -10
  124. package/dist/src/tasks-runner/readiness/ready-when.js +197 -42
  125. package/dist/src/tasks-runner/readiness/startup-host.d.ts +1 -0
  126. package/dist/src/tasks-runner/readiness/startup-host.js +32 -0
  127. package/dist/src/tasks-runner/task-env.js +11 -0
  128. package/dist/src/tasks-runner/task-orchestrator.d.ts +8 -0
  129. package/dist/src/tasks-runner/task-orchestrator.js +152 -42
  130. package/dist/src/tasks-runner/tokens.d.ts +54 -0
  131. package/dist/src/tasks-runner/tokens.js +161 -0
  132. package/dist/src/tasks-runner/utils.d.ts +15 -1
  133. package/dist/src/tasks-runner/utils.js +79 -33
  134. package/dist/src/ultracache/config.d.ts +3 -3
  135. package/dist/src/ultracache/config.js +4 -4
  136. package/dist/src/utils/acknowledge-build-scripts.d.ts +34 -1
  137. package/dist/src/utils/acknowledge-build-scripts.js +171 -32
  138. package/dist/src/utils/long-running-target.d.ts +1 -3
  139. package/dist/src/utils/long-running-target.js +1 -3
  140. package/migrations.json +13 -6
  141. package/package.json +11 -11
  142. package/schemas/migrations-schema.json +11 -0
  143. package/schemas/nx-schema.json +24 -13
  144. package/schemas/project-schema.json +15 -9
  145. package/dist/src/command-line/migrate/agentic/prompts/generic-validation.d.ts +0 -56
  146. package/dist/src/command-line/migrate/agentic/prompts/generic-validation.js +0 -67
  147. package/dist/src/command-line/migrate/agentic/prompts/hybrid-prompt-migration.d.ts +0 -49
  148. package/dist/src/command-line/migrate/agentic/prompts/hybrid-prompt-migration.js +0 -53
  149. package/dist/src/command-line/migrate/agentic/prompts/prompt-migration.d.ts +0 -26
  150. package/dist/src/command-line/migrate/agentic/prompts/prompt-migration.js +0 -27
  151. package/dist/src/command-line/migrate/agentic/prompts/system-prompt.d.ts +0 -70
  152. package/dist/src/command-line/migrate/agentic/prompts/system-prompt.js +0 -113
  153. package/dist/src/command-line/migrate/agentic/run-step.d.ts +0 -68
  154. package/dist/src/command-line/migrate/agentic/run-step.js +0 -148
  155. package/dist/src/command-line/migrate/agentic/runner.d.ts +0 -21
  156. package/dist/src/command-line/migrate/agentic/runner.js +0 -262
  157. package/dist/src/migrations/update-23-0-0/consolidate-release-tag-config.d.ts +0 -9
  158. package/dist/src/migrations/update-23-0-0/consolidate-release-tag-config.js +0 -18
@@ -13,7 +13,7 @@ const nx_json_1 = require("../../config/nx-json");
13
13
  const tree_1 = require("../../generators/tree");
14
14
  const file_map_utils_1 = require("../../project-graph/file-map-utils");
15
15
  const project_graph_1 = require("../../project-graph/project-graph");
16
- const utils_1 = require("../../tasks-runner/utils");
16
+ const interpolate_release_config_1 = require("./utils/interpolate-release-config");
17
17
  const handle_errors_1 = require("../../utils/handle-errors");
18
18
  const is_ci_1 = require("../../utils/is-ci");
19
19
  const output_1 = require("../../utils/output");
@@ -66,6 +66,9 @@ function createAPI(overrideReleaseConfig, ignoreNxJsonConfig) {
66
66
  if (configError) {
67
67
  return await (0, config_1.handleNxReleaseConfigError)(configError);
68
68
  }
69
+ if (args.gitCommitMessage) {
70
+ (0, config_1.validateCommitMessageTokens)(args.gitCommitMessage);
71
+ }
69
72
  // --print-config exits directly as it is not designed to be combined with any other programmatic operations
70
73
  if (args.printConfig) {
71
74
  return (0, print_config_1.printConfigAndExit)({
@@ -168,9 +171,9 @@ function createAPI(overrideReleaseConfig, ignoreNxJsonConfig) {
168
171
  }
169
172
  }
170
173
  // Set resolved version plans on groups
171
- await (0, version_plans_1.setResolvedVersionPlansOnGroups)(rawVersionPlans, releaseGraph.releaseGroups, Object.keys(projectGraph.nodes), args.verbose);
174
+ await (0, version_plans_1.setResolvedVersionPlansOnGroups)(rawVersionPlans, releaseGraph.allReleaseGroups, Object.keys(projectGraph.nodes), args.verbose);
172
175
  // Validate version plans against the filter after resolution
173
- const versionPlanValidationError = (0, version_plan_utils_2.validateResolvedVersionPlansAgainstFilter)(releaseGraph.releaseGroups, releaseGraph.releaseGroupToFilteredProjects);
176
+ const versionPlanValidationError = (0, version_plan_utils_2.validateResolvedVersionPlansAgainstFilter)(releaseGraph.allReleaseGroups, releaseGraph.releaseGroupToFilteredProjects);
174
177
  if (versionPlanValidationError) {
175
178
  output_1.output.error(versionPlanValidationError);
176
179
  process.exit(1);
@@ -632,7 +635,7 @@ async function generateChangelogForWorkspace({ tree, args, nxReleaseConfig, work
632
635
  const ChangelogRendererClass = (0, resolve_changelog_renderer_1.resolveChangelogRenderer)(config.renderer);
633
636
  let interpolatedTreePath = config.file || '';
634
637
  if (interpolatedTreePath) {
635
- interpolatedTreePath = (0, utils_1.interpolate)(interpolatedTreePath, {
638
+ interpolatedTreePath = (0, interpolate_release_config_1.interpolateReleaseConfig)(interpolatedTreePath, {
636
639
  projectName: '', // n/a for the workspace changelog
637
640
  projectRoot: '', // n/a for the workspace changelog
638
641
  workspaceRoot: '', // within the tree, workspaceRoot is the root
@@ -725,7 +728,7 @@ async function generateChangelogForProjects({ tree, args, changes, projectsVersi
725
728
  for (const project of projects) {
726
729
  let interpolatedTreePath = config.file || '';
727
730
  if (interpolatedTreePath) {
728
- interpolatedTreePath = (0, utils_1.interpolate)(interpolatedTreePath, {
731
+ interpolatedTreePath = (0, interpolate_release_config_1.interpolateReleaseConfig)(interpolatedTreePath, {
729
732
  projectName: project.name,
730
733
  projectRoot: project.data.root,
731
734
  workspaceRoot: '', // within the tree, workspaceRoot is the root
@@ -761,7 +764,7 @@ async function generateChangelogForProjects({ tree, args, changes, projectsVersi
761
764
  changelogEntryVersion: releaseVersion.rawVersion,
762
765
  project: project.name,
763
766
  entryWhenNoChanges: typeof config.entryWhenNoChanges === 'string'
764
- ? (0, utils_1.interpolate)(config.entryWhenNoChanges, {
767
+ ? (0, interpolate_release_config_1.interpolateReleaseConfig)(config.entryWhenNoChanges, {
765
768
  projectName: project.name,
766
769
  projectRoot: project.data.root,
767
770
  workspaceRoot: '', // within the tree, workspaceRoot is the root
@@ -59,6 +59,7 @@ export declare function createNxReleaseConfig(projectGraph: ProjectGraph, projec
59
59
  nxReleaseConfig: NxReleaseConfig | null;
60
60
  }>;
61
61
  export declare function handleNxReleaseConfigError(error: CreateNxReleaseConfigError): Promise<never>;
62
+ export declare function validateCommitMessageTokens(commitMessage: string): void;
62
63
  /**
63
64
  * Full form of the createRelease config, with the provider, hostname, and apiBaseUrl resolved.
64
65
  */
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.DEFAULT_VERSION_ACTIONS_PATH = exports.IMPLICIT_DEFAULT_RELEASE_GROUP = void 0;
4
4
  exports.createNxReleaseConfig = createNxReleaseConfig;
5
5
  exports.handleNxReleaseConfigError = handleNxReleaseConfigError;
6
+ exports.validateCommitMessageTokens = validateCommitMessageTokens;
6
7
  /**
7
8
  * `nx release` is a powerful feature which spans many possible use cases. The possible variations
8
9
  * of configuration are therefore quite complex, particularly when you consider release groups.
@@ -25,18 +26,14 @@ const path_1 = require("../../../utils/path");
25
26
  const workspace_root_1 = require("../../../utils/workspace-root");
26
27
  const github_1 = require("../utils/remote-release-clients/github");
27
28
  const gitlab_1 = require("../utils/remote-release-clients/gitlab");
29
+ const interpolate_release_config_1 = require("../utils/interpolate-release-config");
28
30
  const resolve_changelog_renderer_1 = require("../utils/resolve-changelog-renderer");
29
31
  const resolve_nx_json_error_message_1 = require("../utils/resolve-nx-json-error-message");
30
32
  const conventional_commits_1 = require("./conventional-commits");
31
33
  exports.IMPLICIT_DEFAULT_RELEASE_GROUP = '__default__';
32
34
  exports.DEFAULT_VERSION_ACTIONS_PATH = '@nx/js/src/release/version-actions';
33
- // TODO(v24): remove this helper, the call site in createNxReleaseConfig, and
34
- // the corresponding handleNxReleaseConfigError case. The deprecated flat
35
- // `releaseTagPattern*` properties were moved to the nested `releaseTag`
36
- // object in Nx 22 and the consolidation migration runs again in Nx 23 to
37
- // catch any configs added after the v22 migration. Once Nx 24 lands, configs
38
- // that still carry the legacy keys are expected to have been repaired via
39
- // `nx repair`, and we can drop this back-compat error path entirely.
35
+ // Kept on purpose: these keys are otherwise ignored, so a stale config would
36
+ // silently tag with the default pattern. `nx repair` fixes them (22-0-0 migration).
40
37
  const LEGACY_RELEASE_TAG_PROPERTY_NAMES = [
41
38
  'releaseTagPattern',
42
39
  'releaseTagPatternCheckAllBranchesWhen',
@@ -69,7 +66,6 @@ function detectLegacyReleaseTagProperties(userConfig) {
69
66
  }
70
67
  // Apply default configuration to any optional user configuration and handle known errors
71
68
  async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig = {}) {
72
- // TODO(v24): remove this back-compat error along with detectLegacyReleaseTagProperties
73
69
  const legacyReleaseTagProperties = detectLegacyReleaseTagProperties(userConfig);
74
70
  if (legacyReleaseTagProperties.length > 0) {
75
71
  return {
@@ -630,6 +626,15 @@ async function createNxReleaseConfig(projectGraph, projectFileMap, userConfig =
630
626
  }
631
627
  }
632
628
  }
629
+ // Before validateChangelogConfig, which reports any renderer path error as
630
+ // an unresolvable renderer
631
+ validateReleaseConfigTokens({
632
+ releaseTag: WORKSPACE_DEFAULTS.releaseTag,
633
+ git: rootGitConfig,
634
+ version: rootVersionConfig,
635
+ changelog: rootChangelogConfig,
636
+ groups: releaseGroups,
637
+ });
633
638
  const configError = validateChangelogConfig(releaseGroups, rootChangelogConfig);
634
639
  if (configError) {
635
640
  return {
@@ -775,7 +780,6 @@ async function handleNxReleaseConfigError(error) {
775
780
  });
776
781
  }
777
782
  break;
778
- // TODO(v24): remove this case along with detectLegacyReleaseTagProperties
779
783
  case 'LEGACY_RELEASE_TAG_PATTERN_PROPERTIES_DETECTED':
780
784
  {
781
785
  const properties = error.data.properties;
@@ -1038,6 +1042,41 @@ function isProjectPublic(project, projectGraph, projectFileMap) {
1038
1042
  return false;
1039
1043
  }
1040
1044
  }
1045
+ const releaseTagPatternTokens = ['version', 'projectName', 'releaseGroupName'];
1046
+ const commitMessageTokens = ['version', 'projectName'];
1047
+ const changelogFileTokens = ['projectName', 'projectRoot', 'workspaceRoot'];
1048
+ const changelogRendererTokens = ['workspaceRoot'];
1049
+ /**
1050
+ * A release can interpolate these fields after it writes files, so an invalid
1051
+ * token has to fail when the config is loaded
1052
+ */
1053
+ function validateReleaseConfigTokens(config) {
1054
+ const templates = [
1055
+ [config.releaseTag.pattern, releaseTagPatternTokens],
1056
+ [config.git.commitMessage, commitMessageTokens],
1057
+ [config.version.git.commitMessage, commitMessageTokens],
1058
+ [config.changelog.git.commitMessage, commitMessageTokens],
1059
+ ];
1060
+ const { workspaceChangelog } = config.changelog;
1061
+ if (workspaceChangelog) {
1062
+ // The workspace changelog uses its entryWhenNoChanges as written
1063
+ templates.push([workspaceChangelog.file, changelogFileTokens], [workspaceChangelog.renderer, changelogRendererTokens]);
1064
+ }
1065
+ for (const group of Object.values(config.groups)) {
1066
+ templates.push([group.releaseTag.pattern, releaseTagPatternTokens]);
1067
+ if (group.changelog) {
1068
+ templates.push([group.changelog.file, changelogFileTokens], [group.changelog.entryWhenNoChanges, changelogFileTokens], [group.changelog.renderer, changelogRendererTokens]);
1069
+ }
1070
+ }
1071
+ for (const [template, tokens] of templates) {
1072
+ if (typeof template === 'string') {
1073
+ (0, interpolate_release_config_1.validateReleaseConfigTemplate)(template, tokens);
1074
+ }
1075
+ }
1076
+ }
1077
+ function validateCommitMessageTokens(commitMessage) {
1078
+ (0, interpolate_release_config_1.validateReleaseConfigTemplate)(commitMessage, commitMessageTokens);
1079
+ }
1041
1080
  /**
1042
1081
  * We need to ensure that changelog renderers are resolvable up front so that we do not end up erroring after performing
1043
1082
  * actions later, and we also make sure that any configured createRelease options are valid.
@@ -84,9 +84,9 @@ function createAPI(overrideReleaseConfig, ignoreNxJsonConfig) {
84
84
  });
85
85
  // Suppress the filter log for the changelog command as it would have already been printed by the version command
86
86
  process.env.NX_RELEASE_INTERNAL_SUPPRESS_FILTER_LOG = 'true';
87
- await (0, version_plans_1.setResolvedVersionPlansOnGroups)(rawVersionPlans, releaseGraph.releaseGroups, Object.keys(projectGraph.nodes), args.verbose);
87
+ await (0, version_plans_1.setResolvedVersionPlansOnGroups)(rawVersionPlans, releaseGraph.allReleaseGroups, Object.keys(projectGraph.nodes), args.verbose);
88
88
  // Validate version plans against the filter after resolution
89
- const versionPlanValidationError = (0, version_plan_utils_1.validateResolvedVersionPlansAgainstFilter)(releaseGraph.releaseGroups, releaseGraph.releaseGroupToFilteredProjects);
89
+ const versionPlanValidationError = (0, version_plan_utils_1.validateResolvedVersionPlansAgainstFilter)(releaseGraph.allReleaseGroups, releaseGraph.releaseGroupToFilteredProjects);
90
90
  if (versionPlanValidationError) {
91
91
  output_1.output.error(versionPlanValidationError);
92
92
  process.exit(1);
@@ -22,7 +22,7 @@ exports.getFirstProjectCommit = getFirstProjectCommit;
22
22
  */
23
23
  const node_path_1 = require("node:path");
24
24
  const semver_1 = require("semver");
25
- const utils_1 = require("../../../tasks-runner/utils");
25
+ const interpolate_release_config_1 = require("./interpolate-release-config");
26
26
  const workspace_root_1 = require("../../../utils/workspace-root");
27
27
  const exec_command_1 = require("./exec-command");
28
28
  const shared_1 = require("./shared");
@@ -103,17 +103,18 @@ function extractTagAndVersion(tag, tagRegexp, options) {
103
103
  */
104
104
  async function getLatestGitTagForPattern(releaseTagPattern, additionalInterpolationData = {}, resolveTags, options) {
105
105
  const { requireSemver, strictPreid, preid, checkAllBranchesWhen } = options;
106
+ // Outside the try: an invalid pattern must fail, not read as "no tags"
107
+ const interpolatedTagPattern = (0, interpolate_release_config_1.interpolateReleaseConfig)(releaseTagPattern, {
108
+ version: '%v%',
109
+ projectName: '%p%',
110
+ releaseGroupName: '%rg%',
111
+ ...additionalInterpolationData,
112
+ });
106
113
  try {
107
114
  let tags = await resolveTags(checkAllBranchesWhen);
108
115
  if (!tags.length) {
109
116
  return null;
110
117
  }
111
- const interpolatedTagPattern = (0, utils_1.interpolate)(releaseTagPattern, {
112
- version: '%v%',
113
- projectName: '%p%',
114
- releaseGroupName: '%rg%',
115
- ...additionalInterpolationData,
116
- });
117
118
  const tagRegexp = `^${escapeRegExp(interpolatedTagPattern)
118
119
  .replace('%v%', '(.+)')
119
120
  .replace('%p%', '(.+)')
@@ -0,0 +1,6 @@
1
+ export declare function interpolateReleaseConfig(template: string, data: Record<string, unknown>): string;
2
+ /**
3
+ * Throws what `interpolateReleaseConfig` throws for `template` when it gets
4
+ * values for `tokens`, so a release can fail before it writes anything
5
+ */
6
+ export declare function validateReleaseConfigTemplate(template: string, tokens: readonly string[]): void;
@@ -0,0 +1,39 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.interpolateReleaseConfig = interpolateReleaseConfig;
4
+ exports.validateReleaseConfigTemplate = validateReleaseConfigTemplate;
5
+ const tokens_1 = require("../../../tasks-runner/tokens");
6
+ const utils_1 = require("../../../tasks-runner/utils");
7
+ // A call site passes only the values it has, so a fallback is found by name
8
+ const releaseTokens = new Set([
9
+ 'version',
10
+ 'projectName',
11
+ 'releaseGroupName',
12
+ 'projectRoot',
13
+ 'workspaceRoot',
14
+ ]);
15
+ function interpolateReleaseConfig(template, data) {
16
+ rejectFallbacks(template);
17
+ return (0, utils_1.interpolate)(template, data, {
18
+ envNotAllowed: (template) => `Release configuration '${template}' is invalid. It can't read environment variables, because every release run must resolve it the same way.`,
19
+ });
20
+ }
21
+ /**
22
+ * Throws what `interpolateReleaseConfig` throws for `template` when it gets
23
+ * values for `tokens`, so a release can fail before it writes anything
24
+ */
25
+ function validateReleaseConfigTemplate(template, tokens) {
26
+ interpolateReleaseConfig(template, Object.fromEntries(tokens.map((token) => [token, ''])));
27
+ }
28
+ // Tags, commit messages and the previous-tag lookup fill in different values,
29
+ // so a fallback wouldn't resolve the same way in each
30
+ function rejectFallbacks(template) {
31
+ const nodes = (0, tokens_1.parseTokens)(template, {
32
+ isToken: (name) => name === 'env' || releaseTokens.has(name),
33
+ read: () => undefined,
34
+ noValue: (token) => token,
35
+ });
36
+ if (nodes.some((node) => node.kind === 'token' && node.parts.length > 1)) {
37
+ throw new Error(`Release configuration '${template}' is invalid. It can't use ?? fallbacks.`);
38
+ }
39
+ }
@@ -107,6 +107,11 @@ export declare class ReleaseGraph {
107
107
  title: string;
108
108
  bodyLines: string[];
109
109
  } | null;
110
+ /**
111
+ * Every configured release group, regardless of filters. Version plans must be resolved
112
+ * against these, as pending plans may target projects outside the current filter.
113
+ */
114
+ readonly allReleaseGroups: ReleaseGroupWithName[];
110
115
  constructor(releaseGroups: ReleaseGroupWithName[], filters: {
111
116
  projects?: string[];
112
117
  groups?: string[];
@@ -57,6 +57,7 @@ class ReleaseGraph {
57
57
  * Null if no filters were applied.
58
58
  */
59
59
  this.filterLog = null;
60
+ this.allReleaseGroups = [...releaseGroups];
60
61
  }
61
62
  /**
62
63
  * Initialize the graph by building all relationships and caches
@@ -2,14 +2,14 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.resolveChangelogRenderer = resolveChangelogRenderer;
4
4
  const register_1 = require("../../../plugins/js/utils/register");
5
- const utils_1 = require("../../../tasks-runner/utils");
5
+ const interpolate_release_config_1 = require("./interpolate-release-config");
6
6
  const workspace_root_1 = require("../../../utils/workspace-root");
7
7
  function resolveChangelogRenderer(changelogRendererPathOrImplementation) {
8
8
  // An implementation was provided directly via the programmatic API
9
9
  if (typeof changelogRendererPathOrImplementation === 'function') {
10
10
  return changelogRendererPathOrImplementation;
11
11
  }
12
- const interpolatedChangelogRendererPath = (0, utils_1.interpolate)(changelogRendererPathOrImplementation, {
12
+ const interpolatedChangelogRendererPath = (0, interpolate_release_config_1.interpolateReleaseConfig)(changelogRendererPathOrImplementation, {
13
13
  workspaceRoot: workspace_root_1.workspaceRoot,
14
14
  });
15
15
  // TS renderers go through loadTsFile (native-strip -> swc/ts-node + paths).
@@ -12,7 +12,7 @@ exports.getCommitsRelevantToProjects = getCommitsRelevantToProjects;
12
12
  const tslib_1 = require("tslib");
13
13
  const pc = tslib_1.__importStar(require("picocolors"));
14
14
  const semver_1 = require("semver");
15
- const utils_1 = require("../../../tasks-runner/utils");
15
+ const interpolate_release_config_1 = require("./interpolate-release-config");
16
16
  const output_1 = require("../../../utils/output");
17
17
  const git_1 = require("./git");
18
18
  const find_matching_projects_1 = require("../../../utils/find-matching-projects");
@@ -34,7 +34,7 @@ class ReleaseVersion {
34
34
  releaseGroupName, // optional release group name to interpolate into the releaseTagPattern
35
35
  }) {
36
36
  this.rawVersion = version;
37
- this.gitTag = (0, utils_1.interpolate)(releaseTagPattern, {
37
+ this.gitTag = (0, interpolate_release_config_1.interpolateReleaseConfig)(releaseTagPattern, {
38
38
  version,
39
39
  projectName: projectName
40
40
  ? (0, git_1.sanitizeProjectNameForGitTag)(projectName)
@@ -83,7 +83,7 @@ function createCommitMessageValues(releaseGroups, releaseGroupToFilteredProjects
83
83
  releaseTagPattern: releaseGroup.releaseTag.pattern,
84
84
  releaseGroupName: releaseGroup.name,
85
85
  });
86
- commitMessageValues[0] = (0, utils_1.interpolate)(commitMessageValues[0], {
86
+ commitMessageValues[0] = (0, interpolate_release_config_1.interpolateReleaseConfig)(commitMessageValues[0], {
87
87
  version: releaseVersion.rawVersion,
88
88
  }).trim();
89
89
  return commitMessageValues;
@@ -106,7 +106,7 @@ function createCommitMessageValues(releaseGroups, releaseGroupToFilteredProjects
106
106
  projectName: releaseGroupProjectNames[0],
107
107
  releaseGroupName: releaseGroup.name,
108
108
  });
109
- commitMessageValues[0] = (0, utils_1.interpolate)(commitMessageValues[0], {
109
+ commitMessageValues[0] = (0, interpolate_release_config_1.interpolateReleaseConfig)(commitMessageValues[0], {
110
110
  version: releaseVersion.rawVersion,
111
111
  projectName: releaseGroupProjectNames[0],
112
112
  }).trim();
@@ -199,14 +199,14 @@ function createGitTagValues(releaseGroups, releaseGroupToFilteredProjects, versi
199
199
  if (preferDockerVersion === 'both') {
200
200
  // Create tags for both docker and semver versions
201
201
  if (projectVersionData.dockerVersion) {
202
- tags.push((0, utils_1.interpolate)(releaseGroup.releaseTag.pattern, {
202
+ tags.push((0, interpolate_release_config_1.interpolateReleaseConfig)(releaseGroup.releaseTag.pattern, {
203
203
  version: projectVersionData.dockerVersion,
204
204
  projectName: (0, git_1.sanitizeProjectNameForGitTag)(project),
205
205
  releaseGroupName: releaseGroup.name,
206
206
  }));
207
207
  }
208
208
  if (projectVersionData.newVersion) {
209
- tags.push((0, utils_1.interpolate)(releaseGroup.releaseTag.pattern, {
209
+ tags.push((0, interpolate_release_config_1.interpolateReleaseConfig)(releaseGroup.releaseTag.pattern, {
210
210
  version: projectVersionData.newVersion,
211
211
  projectName: (0, git_1.sanitizeProjectNameForGitTag)(project),
212
212
  releaseGroupName: releaseGroup.name,
@@ -221,7 +221,7 @@ function createGitTagValues(releaseGroups, releaseGroupToFilteredProjects, versi
221
221
  : (projectVersionData.newVersion ??
222
222
  projectVersionData.dockerVersion);
223
223
  if (version) {
224
- tags.push((0, utils_1.interpolate)(releaseGroup.releaseTag.pattern, {
224
+ tags.push((0, interpolate_release_config_1.interpolateReleaseConfig)(releaseGroup.releaseTag.pattern, {
225
225
  version,
226
226
  projectName: (0, git_1.sanitizeProjectNameForGitTag)(project),
227
227
  releaseGroupName: releaseGroup.name,
@@ -241,13 +241,13 @@ function createGitTagValues(releaseGroups, releaseGroupToFilteredProjects, versi
241
241
  if (preferDockerVersion === 'both') {
242
242
  // Create tags for both docker and semver versions
243
243
  if (projectVersionData.dockerVersion) {
244
- tags.push((0, utils_1.interpolate)(releaseGroup.releaseTag.pattern, {
244
+ tags.push((0, interpolate_release_config_1.interpolateReleaseConfig)(releaseGroup.releaseTag.pattern, {
245
245
  version: projectVersionData.dockerVersion,
246
246
  releaseGroupName: releaseGroup.name,
247
247
  }));
248
248
  }
249
249
  if (projectVersionData.newVersion) {
250
- tags.push((0, utils_1.interpolate)(releaseGroup.releaseTag.pattern, {
250
+ tags.push((0, interpolate_release_config_1.interpolateReleaseConfig)(releaseGroup.releaseTag.pattern, {
251
251
  version: projectVersionData.newVersion,
252
252
  releaseGroupName: releaseGroup.name,
253
253
  }));
@@ -259,7 +259,7 @@ function createGitTagValues(releaseGroups, releaseGroupToFilteredProjects, versi
259
259
  ? (projectVersionData.dockerVersion ?? projectVersionData.newVersion)
260
260
  : (projectVersionData.newVersion ?? projectVersionData.dockerVersion);
261
261
  if (version) {
262
- tags.push((0, utils_1.interpolate)(releaseGroup.releaseTag.pattern, {
262
+ tags.push((0, interpolate_release_config_1.interpolateReleaseConfig)(releaseGroup.releaseTag.pattern, {
263
263
  version,
264
264
  releaseGroupName: releaseGroup.name,
265
265
  }));
@@ -1,10 +1,10 @@
1
1
  import { GroupVersionPlan, ProjectsVersionPlan } from '../config/version-plans';
2
2
  import { ReleaseGroupWithName } from '../config/filter-release-groups';
3
3
  /**
4
- * Validates that all projects in resolved version plans are included in the filtered projects.
5
- * This validation ensures that version plans don't contain projects that aren't being released.
4
+ * Validates that no version plan mixes projects being released with projects outside the release filter,
5
+ * as such a plan could neither be fully applied nor safely deleted.
6
6
  *
7
- * @param releaseGroups - The release groups to validate
7
+ * @param releaseGroups - All configured release groups, so that plans spanning groups outside the filter are caught
8
8
  * @param releaseGroupToFilteredProjects - Map of release groups to their filtered projects
9
9
  * @returns An error object if validation fails, null otherwise
10
10
  */
@@ -29,12 +29,3 @@ export declare function getProjectsAffectedByVersionPlan(plan: GroupVersionPlan
29
29
  * @returns True if ALL projects in the version plan are being filtered/released
30
30
  */
31
31
  export declare function areAllVersionPlanProjectsFiltered(plan: GroupVersionPlan | ProjectsVersionPlan, releaseGroup: ReleaseGroupWithName, filteredProjects: Set<string> | undefined): boolean;
32
- /**
33
- * Finds projects in a version plan that are NOT included in the filtered projects set.
34
- *
35
- * @param plan - The version plan to check
36
- * @param releaseGroup - The release group containing the version plan
37
- * @param filteredProjects - Set of projects that are being released (filtered)
38
- * @returns Array of project names that are in the version plan but not in the filter
39
- */
40
- export declare function getVersionPlanProjectsOutsideFilter(plan: GroupVersionPlan | ProjectsVersionPlan, releaseGroup: ReleaseGroupWithName, filteredProjects: Set<string> | undefined): string[];
@@ -3,43 +3,51 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.validateResolvedVersionPlansAgainstFilter = validateResolvedVersionPlansAgainstFilter;
4
4
  exports.getProjectsAffectedByVersionPlan = getProjectsAffectedByVersionPlan;
5
5
  exports.areAllVersionPlanProjectsFiltered = areAllVersionPlanProjectsFiltered;
6
- exports.getVersionPlanProjectsOutsideFilter = getVersionPlanProjectsOutsideFilter;
7
6
  /**
8
- * Validates that all projects in resolved version plans are included in the filtered projects.
9
- * This validation ensures that version plans don't contain projects that aren't being released.
7
+ * Validates that no version plan mixes projects being released with projects outside the release filter,
8
+ * as such a plan could neither be fully applied nor safely deleted.
10
9
  *
11
- * @param releaseGroups - The release groups to validate
10
+ * @param releaseGroups - All configured release groups, so that plans spanning groups outside the filter are caught
12
11
  * @param releaseGroupToFilteredProjects - Map of release groups to their filtered projects
13
12
  * @returns An error object if validation fails, null otherwise
14
13
  */
15
14
  function validateResolvedVersionPlansAgainstFilter(releaseGroups, releaseGroupToFilteredProjects) {
15
+ const projectsByPlanFile = new Map();
16
16
  for (const releaseGroup of releaseGroups) {
17
- if (releaseGroup.resolvedVersionPlans &&
18
- releaseGroup.resolvedVersionPlans.length > 0) {
19
- const filteredProjects = releaseGroupToFilteredProjects.get(releaseGroup);
20
- for (const plan of releaseGroup.resolvedVersionPlans) {
21
- // check if version plan applies to filtered projects
22
- if (!checkVersionPlanContainsFilteredProjects(plan, releaseGroup, filteredProjects)) {
23
- continue;
17
+ if (!releaseGroup.resolvedVersionPlans) {
18
+ continue;
19
+ }
20
+ const filteredProjects = releaseGroupToFilteredProjects.get(releaseGroup);
21
+ for (const plan of releaseGroup.resolvedVersionPlans) {
22
+ let projects = projectsByPlanFile.get(plan.fileName);
23
+ if (!projects) {
24
+ projects = { filtered: new Set(), outsideFilter: new Set() };
25
+ projectsByPlanFile.set(plan.fileName, projects);
26
+ }
27
+ for (const project of getProjectsAffectedByVersionPlan(plan, releaseGroup)) {
28
+ if (filteredProjects?.has(project)) {
29
+ projects.filtered.add(project);
24
30
  }
25
- // Check if version plan contains projects outside the filter
26
- const projectsOutsideFilter = getVersionPlanProjectsOutsideFilter(plan, releaseGroup, filteredProjects);
27
- if (projectsOutsideFilter.length > 0) {
28
- // Error if version plan contains projects not in the filter
29
- return {
30
- title: `Version plan contains projects not included in the release filter`,
31
- bodyLines: [
32
- `The following projects in the version plan are not being released:`,
33
- ...projectsOutsideFilter.map((p) => ` - ${p}`),
34
- '',
35
- `Either include all projects from the version plan in your release command,`,
36
- `or create separate version plans for different sets of projects.`,
37
- ],
38
- };
31
+ else {
32
+ projects.outsideFilter.add(project);
39
33
  }
40
34
  }
41
35
  }
42
36
  }
37
+ for (const [fileName, { filtered, outsideFilter }] of projectsByPlanFile) {
38
+ if (filtered.size > 0 && outsideFilter.size > 0) {
39
+ return {
40
+ title: `Version plan contains projects not included in the release filter`,
41
+ bodyLines: [
42
+ `The following projects in version plan '${fileName}' are not being released:`,
43
+ ...Array.from(outsideFilter).map((p) => ` - ${p}`),
44
+ '',
45
+ `Either include all projects from the version plan in your release command,`,
46
+ `or create separate version plans for different sets of projects.`,
47
+ ],
48
+ };
49
+ }
50
+ }
43
51
  return null;
44
52
  }
45
53
  /**
@@ -79,33 +87,3 @@ function areAllVersionPlanProjectsFiltered(plan, releaseGroup, filteredProjects)
79
87
  return (planProjects.size > 0 &&
80
88
  Array.from(planProjects).every((project) => filteredProjects.has(project)));
81
89
  }
82
- /**
83
- * Finds projects in a version plan that are NOT included in the filtered projects set.
84
- *
85
- * @param plan - The version plan to check
86
- * @param releaseGroup - The release group containing the version plan
87
- * @param filteredProjects - Set of projects that are being released (filtered)
88
- * @returns Array of project names that are in the version plan but not in the filter
89
- */
90
- function getVersionPlanProjectsOutsideFilter(plan, releaseGroup, filteredProjects) {
91
- if (!filteredProjects) {
92
- return [];
93
- }
94
- const planProjects = getProjectsAffectedByVersionPlan(plan, releaseGroup);
95
- return Array.from(planProjects).filter((project) => !filteredProjects.has(project));
96
- }
97
- /**
98
- * Checks whether the version plan contains any of the filtered projects.
99
- *
100
- * @param plan - The version plan to check.
101
- * @param releaseGroup - The release group associated with the version plan.
102
- * @param filteredProjects - Set of projects that are being released (filtered).
103
- * @returns Returns true if the version plan contains any of the filtered projects, or if no filtered projects are provided.
104
- */
105
- function checkVersionPlanContainsFilteredProjects(plan, releaseGroup, filteredProjects) {
106
- if (!filteredProjects) {
107
- return true;
108
- }
109
- const planProjects = getProjectsAffectedByVersionPlan(plan, releaseGroup);
110
- return Array.from(filteredProjects).some((project) => planProjects.has(project));
111
- }
@@ -5,6 +5,7 @@ exports.resolveVersionActionsForProject = resolveVersionActionsForProject;
5
5
  const node_path_1 = require("node:path");
6
6
  const register_1 = require("../../../plugins/js/utils/register");
7
7
  const utils_1 = require("../../../tasks-runner/utils");
8
+ const interpolate_release_config_1 = require("../utils/interpolate-release-config");
8
9
  const workspace_root_1 = require("../../../utils/workspace-root");
9
10
  const config_1 = require("../config/config");
10
11
  const semver_1 = require("../utils/semver");
@@ -123,7 +124,7 @@ class VersionActions {
123
124
  const interpolatedManifestRoots = this.finalConfigForProject.manifestRootsToUpdate.map((manifestRoot) => {
124
125
  return {
125
126
  ...manifestRoot,
126
- path: (0, utils_1.interpolate)(manifestRoot.path, {
127
+ path: (0, interpolate_release_config_1.interpolateReleaseConfig)(manifestRoot.path, {
127
128
  workspaceRoot: '',
128
129
  projectRoot: this.projectGraphNode.data.root,
129
130
  projectName: this.projectGraphNode.name,
@@ -47,6 +47,9 @@ function createAPI(overrideReleaseConfig, ignoreNxJsonConfig) {
47
47
  if (configError) {
48
48
  return await (0, config_1.handleNxReleaseConfigError)(configError);
49
49
  }
50
+ if (args.gitCommitMessage) {
51
+ (0, config_1.validateCommitMessageTokens)(args.gitCommitMessage);
52
+ }
50
53
  // --print-config exits directly as it is not designed to be combined with any other programmatic operations
51
54
  if (args.printConfig) {
52
55
  return (0, print_config_1.printConfigAndExit)({
@@ -96,9 +99,9 @@ function createAPI(overrideReleaseConfig, ignoreNxJsonConfig) {
96
99
  }
97
100
  if (!args.specifier) {
98
101
  const rawVersionPlans = await (0, version_plans_1.readRawVersionPlans)();
99
- await (0, version_plans_1.setResolvedVersionPlansOnGroups)(rawVersionPlans, releaseGraph.releaseGroups, Object.keys(projectGraph.nodes), args.verbose);
102
+ await (0, version_plans_1.setResolvedVersionPlansOnGroups)(rawVersionPlans, releaseGraph.allReleaseGroups, Object.keys(projectGraph.nodes), args.verbose);
100
103
  // Validate version plans against the filter after resolution
101
- const versionPlanValidationError = (0, version_plan_utils_1.validateResolvedVersionPlansAgainstFilter)(releaseGraph.releaseGroups, releaseGraph.releaseGroupToFilteredProjects);
104
+ const versionPlanValidationError = (0, version_plan_utils_1.validateResolvedVersionPlansAgainstFilter)(releaseGraph.allReleaseGroups, releaseGraph.releaseGroupToFilteredProjects);
102
105
  if (versionPlanValidationError) {
103
106
  output_1.output.error(versionPlanValidationError);
104
107
  process.exit(1);
@@ -21,12 +21,12 @@ async function showProjectsHandler(args) {
21
21
  printWarnings: false,
22
22
  }, nxJson);
23
23
  const explainsTasks = args.affected &&
24
- (0, affected_tasks_1.selectsAffectedTasks)() &&
24
+ (0, affected_tasks_1.selectsAffectedTasks)(nxJson) &&
25
25
  !!args.withTarget?.length &&
26
26
  !args.projects;
27
27
  if ((0, affected_reasons_1.isExplaining)(nxArgs.explain) && !explainsTasks) {
28
28
  throw new Error((0, affected_reasons_1.explainUnavailable)([
29
- !(0, affected_tasks_1.selectsAffectedTasks)() && 'NX_LEGACY_AFFECTED=false',
29
+ !(0, affected_tasks_1.selectsAffectedTasks)(nxJson) && (0, affected_tasks_1.taskGranularityRequirement)(),
30
30
  !args.affected && '--affected',
31
31
  !args.withTarget?.length && 'targets passed with --withTarget (-t)',
32
32
  ].filter(Boolean), args.projects ? ['--projects'] : []));
@@ -35,7 +35,9 @@ async function showProjectsHandler(args) {
35
35
  if (args.affected) {
36
36
  const touchedFiles = await getTouchedFiles(nxArgs);
37
37
  // With a target, list projects owning an affected task for it, matching `affected -t`.
38
- if ((0, affected_tasks_1.selectsAffectedTasks)() && args.withTarget?.length && !args.projects) {
38
+ if ((0, affected_tasks_1.selectsAffectedTasks)(nxJson) &&
39
+ args.withTarget?.length &&
40
+ !args.projects) {
39
41
  const affectedTasks = await (0, affected_tasks_1.computeAffectedTasks)({
40
42
  projectGraph: graph,
41
43
  nxJson,
@@ -249,7 +249,7 @@ function withAffectedOptions(yargs) {
249
249
  function withExplainOption(yargs) {
250
250
  return yargs.option('explain', {
251
251
  type: 'string',
252
- describe: 'Print why each task was considered affected, instead of running anything. Needs task selection (NX_LEGACY_AFFECTED=false). Pass a file path to save the reasons as JSON instead. Pass "stdout" to print the JSON to the terminal.',
252
+ describe: 'Print why each task was considered affected, instead of running anything. Not available with affected.legacy in nx.json. Pass a file path to save the reasons as JSON instead. Pass "stdout" to print the JSON to the terminal.',
253
253
  // Same shape as `--graph`: the value is a destination, and a bare
254
254
  // `--explain` has to arrive as a boolean. `nx affected` leaves `--json`
255
255
  // undeclared so it still reaches the executor.
@@ -106,6 +106,12 @@ export interface MigrationsJsonEntry {
106
106
  * an outer agent or to the user.
107
107
  */
108
108
  documentation?: string;
109
+ /**
110
+ * Marks a migration that applies an optional dependency update.
111
+ * `nx migrate --include=required` skips it, and `--include=optional` runs it
112
+ * whenever `requires` is met, so it must set `requires`.
113
+ */
114
+ optionalUpdate?: boolean;
109
115
  }
110
116
  export type MigrationDetailsWithId = GeneratedMigrationDetails & {
111
117
  id: string;