nx 20.0.0-beta.6 → 20.0.0-beta.8

package/src/command-line/nx-commands.js

@@ -29,6 +29,7 @@ const command_object_23 = require("./login/command-object");
 const command_object_24 = require("./logout/command-object");
 const command_objects_1 = require("./deprecated/command-objects");
 const command_object_25 = require("./sync/command-object");
+const output_1 = require("../utils/output");
 // Ensure that the output takes up the available width of the terminal.
 yargs.wrap(yargs.terminalWidth());
 exports.parserConfiguration = {
@@ -82,26 +83,46 @@ exports.commandsObject = yargs
     .command(command_object_23.yargsLoginCommand)
     .command(command_object_24.yargsLogoutCommand)
     .command(resolveConformanceCommandObject())
+    .command(resolveConformanceCheckCommandObject())
     .scriptName('nx')
     .help()
     // NOTE: we handle --version in nx.ts, this just tells yargs that the option exists
     // so that it shows up in help. The default yargs implementation of --version is not
     // hit, as the implementation in nx.ts is hit first and calls process.exit(0).
     .version();
+function createMissingConformanceCommand(command) {
+    return {
+        command,
+        // Hide from --help output in the common case of not having the plugin installed
+        describe: false,
+        handler: () => {
+            output_1.output.error({
+                title: `${command} is not available`,
+                bodyLines: [
+                    `In order to use the \`nx ${command}\` command you must have an active Powerpack license and the \`@nx/powerpack-conformance\` plugin installed.`,
+                    '',
+                    'To learn more, visit https://nx.dev/features/powerpack/conformance',
+                ],
+            });
+            process.exit(1);
+        },
+    };
+}
 function resolveConformanceCommandObject() {
     try {
         const { yargsConformanceCommand } = require('@nx/powerpack-conformance');
         return yargsConformanceCommand;
     }
-    catch (e) {
-        return {
-            command: 'conformance',
-            // Hide from --help output in the common case of not having the plugin installed
-            describe: false,
-            handler: () => {
-                // TODO: Add messaging to help with learning more about powerpack and conformance
-                process.exit(1);
-            },
-        };
+    catch {
+        return createMissingConformanceCommand('conformance');
+    }
+}
+function resolveConformanceCheckCommandObject() {
+    try {
+        const { yargsConformanceCheckCommand, } = require('@nx/powerpack-conformance');
+        return yargsConformanceCheckCommand;
+    }
+    catch {
+        return createMissingConformanceCommand('conformance:check');
     }
 }

package/src/command-line/release/changelog.d.ts

@@ -22,10 +22,10 @@ export interface ChangelogChange {
     body?: string;
     isBreaking?: boolean;
     githubReferences?: Reference[];
-    author?: {
+    authors?: {
         name: string;
         email: string;
-    };
+    }[];
     shortHash?: string;
     revertedHashes?: string[];
 }

package/src/command-line/release/changelog.js

@@ -162,7 +162,8 @@ function createAPI(overrideReleaseConfig) {
                                 body: '',
                                 isBreaking: releaseType.isBreaking,
                                 githubReferences,
-                                author,
+                                // TODO(JamesHenry): Implement support for Co-authored-by and adding multiple authors
+                                authors: [author],
                                 affectedProjects: '*',
                             }
                             : vp.triggeredByProjects.map((project) => {
@@ -173,7 +174,8 @@ function createAPI(overrideReleaseConfig) {
                                     body: '',
                                     isBreaking: releaseType.isBreaking,
                                     githubReferences,
-                                    author,
+                                    // TODO(JamesHenry): Implement support for Co-authored-by and adding multiple authors
+                                    authors: [author],
                                     affectedProjects: [project],
                                 };
                             });
@@ -209,7 +211,7 @@ function createAPI(overrideReleaseConfig) {
                     body: c.body,
                     isBreaking: c.isBreaking,
                     githubReferences: c.references,
-                    author: c.author,
+                    authors: [c.author],
                     shortHash: c.shortHash,
                     revertedHashes: c.revertedHashes,
                     affectedProjects: '*',
@@ -313,13 +315,14 @@ function createAPI(overrideReleaseConfig) {
                             }
                             const releaseType = versionPlanSemverReleaseTypeToChangelogType(bumpForProject);
                             let githubReferences = [];
-                            let author = undefined;
+                            let authors = [];
                             const parsedCommit = vp.commit
                                 ? (0, git_1.parseGitCommit)(vp.commit, true)
                                 : null;
                             if (parsedCommit) {
                                 githubReferences = parsedCommit.references;
-                                author = parsedCommit.author;
+                                // TODO(JamesHenry): Implement support for Co-authored-by and adding multiple authors
+                                authors = [parsedCommit.author];
                             }
                             return {
                                 type: releaseType.type,
@@ -329,7 +332,7 @@ function createAPI(overrideReleaseConfig) {
                                 isBreaking: releaseType.isBreaking,
                                 affectedProjects: Object.keys(vp.projectVersionBumps),
                                 githubReferences,
-                                author,
+                                authors,
                             };
                         })
                             .filter(Boolean);
@@ -365,7 +368,8 @@ function createAPI(overrideReleaseConfig) {
                             body: c.body,
                             isBreaking: c.isBreaking,
                             githubReferences: c.references,
-                            author: c.author,
+                            // TODO(JamesHenry): Implement support for Co-authored-by and adding multiple authors
+                            authors: [c.author],
                             shortHash: c.shortHash,
                             revertedHashes: c.revertedHashes,
                             affectedProjects: commitChangesNonProjectFiles(c, fileMap.nonProjectFiles)
@@ -376,15 +380,12 @@ function createAPI(overrideReleaseConfig) {
                     const projectChangelogs = await generateChangelogForProjects({
                         tree,
                         args,
-                        projectGraph,
                         changes,
                         projectsVersionData,
                         releaseGroup,
                         projects: [project],
                         nxReleaseConfig,
                         projectToAdditionalDependencyBumps,
-                        // TODO: remove this after the changelog renderer is refactored to remove coupling with git commits
-                        commits: filterHiddenCommits(commits, nxReleaseConfig.conventionalCommits),
                     });
                     let hasPushed = false;
                     for (const [projectName, projectChangelog] of Object.entries(projectChangelogs)) {
@@ -436,7 +437,8 @@ function createAPI(overrideReleaseConfig) {
                                 body: '',
                                 isBreaking: releaseType.isBreaking,
                                 githubReferences,
-                                author,
+                                // TODO(JamesHenry): Implement support for Co-authored-by and adding multiple authors
+                                authors: [author],
                                 affectedProjects: '*',
                             }
                             : vp.triggeredByProjects.map((project) => {
@@ -447,7 +449,8 @@ function createAPI(overrideReleaseConfig) {
                                     body: '',
                                     isBreaking: releaseType.isBreaking,
                                     githubReferences,
-                                    author,
+                                    // TODO(JamesHenry): Implement support for Co-authored-by and adding multiple authors
+                                    authors: [author],
                                     affectedProjects: [project],
                                 };
                             });
@@ -482,7 +485,8 @@ function createAPI(overrideReleaseConfig) {
                         body: c.body,
                         isBreaking: c.isBreaking,
                         githubReferences: c.references,
-                        author: c.author,
+                        // TODO(JamesHenry): Implement support for Co-authored-by and adding multiple authors
+                        authors: [c.author],
                         shortHash: c.shortHash,
                         revertedHashes: c.revertedHashes,
                         affectedProjects: commitChangesNonProjectFiles(c, fileMap.nonProjectFiles)
@@ -493,15 +497,12 @@ function createAPI(overrideReleaseConfig) {
                 const projectChangelogs = await generateChangelogForProjects({
                     tree,
                     args,
-                    projectGraph,
                     changes,
                     projectsVersionData,
                     releaseGroup,
                     projects: projectNodes,
                     nxReleaseConfig,
                     projectToAdditionalDependencyBumps,
-                    // TODO: remove this after the changelog renderer is refactored to remove coupling with git commits
-                    commits: filterHiddenCommits(commits, nxReleaseConfig.conventionalCommits),
                 });
                 let hasPushed = false;
                 for (const [projectName, projectChangelog] of Object.entries(projectChangelogs)) {
@@ -716,7 +717,7 @@ async function generateChangelogForWorkspace({ tree, args, projectGraph, nxRelea
     const interactive = args.interactive === 'all' || args.interactive === 'workspace';
     const dryRun = !!args.dryRun;
     const gitRemote = args.gitRemote;
-    const changelogRenderer = (0, resolve_changelog_renderer_1.resolveChangelogRenderer)(config.renderer);
+    const ChangelogRendererClass = (0, resolve_changelog_renderer_1.resolveChangelogRenderer)(config.renderer);
     let interpolatedTreePath = config.file || '';
     if (interpolatedTreePath) {
         interpolatedTreePath = (0, utils_1.interpolate)(interpolatedTreePath, {
@@ -736,18 +737,17 @@ async function generateChangelogForWorkspace({ tree, args, projectGraph, nxRelea
         });
     }
     const githubRepoData = (0, github_1.getGitHubRepoData)(gitRemote, config.createRelease);
-    let contents = await changelogRenderer({
-        projectGraph,
+    const changelogRenderer = new ChangelogRendererClass({
         changes,
-        commits,
-        releaseVersion: releaseVersion.rawVersion,
+        changelogEntryVersion: releaseVersion.rawVersion,
         project: null,
-        repoSlug: githubRepoData?.slug,
+        isVersionPlans: false,
         repoData: githubRepoData,
         entryWhenNoChanges: config.entryWhenNoChanges,
         changelogRenderOptions: config.renderOptions,
         conventionalCommitsConfig: nxReleaseConfig.conventionalCommits,
     });
+    let contents = await changelogRenderer.render();
     /**
      * If interactive mode, make the changelog contents available for the user to modify in their editor of choice,
      * in a similar style to git interactive rebases/merges.
@@ -789,7 +789,7 @@ async function generateChangelogForWorkspace({ tree, args, projectGraph, nxRelea
         contents,
     };
 }
-async function generateChangelogForProjects({ tree, args, projectGraph, changes, commits, projectsVersionData, releaseGroup, projects, nxReleaseConfig, projectToAdditionalDependencyBumps, }) {
+async function generateChangelogForProjects({ tree, args, changes, projectsVersionData, releaseGroup, projects, nxReleaseConfig, projectToAdditionalDependencyBumps, }) {
     const config = releaseGroup.changelog;
     // The entire feature is disabled at the release group level, exit early
     if (config === false) {
@@ -799,7 +799,7 @@ async function generateChangelogForProjects({ tree, args, projectGraph, changes,
     const interactive = args.interactive === 'all' || args.interactive === 'projects';
     const dryRun = !!args.dryRun;
     const gitRemote = args.gitRemote;
-    const changelogRenderer = (0, resolve_changelog_renderer_1.resolveChangelogRenderer)(config.renderer);
+    const ChangelogRendererClass = (0, resolve_changelog_renderer_1.resolveChangelogRenderer)(config.renderer);
     const projectChangelogs = {};
     for (const project of projects) {
         let interpolatedTreePath = config.file || '';
@@ -829,13 +829,10 @@ async function generateChangelogForProjects({ tree, args, projectGraph, changes,
             });
         }
         const githubRepoData = (0, github_1.getGitHubRepoData)(gitRemote, config.createRelease);
-        let contents = await changelogRenderer({
-            projectGraph,
+        const changelogRenderer = new ChangelogRendererClass({
             changes,
-            commits,
-            releaseVersion: releaseVersion.rawVersion,
+            changelogEntryVersion: releaseVersion.rawVersion,
             project: project.name,
-            repoSlug: githubRepoData?.slug,
             repoData: githubRepoData,
             entryWhenNoChanges: typeof config.entryWhenNoChanges === 'string'
                 ? (0, utils_1.interpolate)(config.entryWhenNoChanges, {
@@ -845,11 +842,13 @@ async function generateChangelogForProjects({ tree, args, projectGraph, changes,
                 })
                 : false,
             changelogRenderOptions: config.renderOptions,
+            isVersionPlans: !!releaseGroup.versionPlans,
             conventionalCommitsConfig: releaseGroup.versionPlans
                 ? null
                 : nxReleaseConfig.conventionalCommits,
             dependencyBumps: projectToAdditionalDependencyBumps.get(project.name),
         });
+        let contents = await changelogRenderer.render();
         /**
          * If interactive mode, make the changelog contents available for the user to modify in their editor of choice,
          * in a similar style to git interactive rebases/merges.

package/src/command-line/release/utils/git.js

@@ -16,7 +16,7 @@ exports.getFirstGitCommit = getFirstGitCommit;
  * https://github.com/unjs/changelogen
  */
 const utils_1 = require("../../../tasks-runner/utils");
-const app_root_1 = require("../../../utils/app-root");
+const workspace_root_1 = require("../../../utils/workspace-root");
 const exec_command_1 = require("./exec-command");
 function escapeRegExp(string) {
     return string.replace(/[/\-\\^$*+?.()|[\]{}]/g, '\\$&');
@@ -118,7 +118,7 @@ async function getChangedTrackedFiles(cwd) {
 async function gitAdd({ changedFiles, deletedFiles, dryRun, verbose, logFn, cwd, }) {
     logFn = logFn || console.log;
     // Default to running git add related commands from the workspace root
-    cwd = cwd || app_root_1.workspaceRoot;
+    cwd = cwd || workspace_root_1.workspaceRoot;
     let ignoredFiles = [];
     let filesToAdd = [];
     for (const f of changedFiles ?? []) {

package/src/command-line/release/utils/resolve-changelog-renderer.d.ts

@@ -1,2 +1,2 @@
-import type { ChangelogRenderer } from '../../../../release/changelog-renderer';
-export declare function resolveChangelogRenderer(changelogRendererPath: string): ChangelogRenderer;
+import type ChangelogRenderer from '../../../../release/changelog-renderer';
+export declare function resolveChangelogRenderer(changelogRendererPath: string): typeof ChangelogRenderer;

package/src/command-line/release/utils/resolve-changelog-renderer.js

@@ -10,7 +10,7 @@ function resolveChangelogRenderer(changelogRendererPath) {
         workspaceRoot: workspace_root_1.workspaceRoot,
     });
     // Try and load the provided (or default) changelog renderer
-    let changelogRenderer;
+    let ChangelogRendererClass;
     let cleanupTranspiler = () => { };
     try {
         const rootTsconfigPath = (0, typescript_1.getRootTsConfigPath)();
@@ -18,7 +18,7 @@ function resolveChangelogRenderer(changelogRendererPath) {
             cleanupTranspiler = (0, register_1.registerTsProject)(rootTsconfigPath);
         }
         const r = require(interpolatedChangelogRendererPath);
-        changelogRenderer = r.default || r;
+        ChangelogRendererClass = r.default || r;
     }
     catch (err) {
         throw err;
@@ -26,5 +26,5 @@ function resolveChangelogRenderer(changelogRendererPath) {
     finally {
         cleanupTranspiler();
     }
-    return changelogRenderer;
+    return ChangelogRendererClass;
 }

package/src/command-line/run/run-one.js

@@ -11,7 +11,6 @@ const split_target_1 = require("../../utils/split-target");
 const output_1 = require("../../utils/output");
 const configuration_1 = require("../../config/configuration");
 const calculate_default_project_name_1 = require("../../config/calculate-default-project-name");
-const workspace_configuration_check_1 = require("../../utils/workspace-configuration-check");
 const graph_1 = require("../graph/graph");
 async function runOne(cwd, args, extraTargetDependencies = {}, extraOptions = {
     excludeTaskDependencies: args.excludeTaskDependencies,
@@ -19,7 +18,6 @@ async function runOne(cwd, args, extraTargetDependencies = {}, extraOptions = {
 }) {
     perf_hooks_1.performance.mark('code-loading:end');
     perf_hooks_1.performance.measure('code-loading', 'init-local', 'code-loading:end');
-    (0, workspace_configuration_check_1.workspaceConfigurationCheck)();
     const nxJson = (0, configuration_1.readNxJson)();
     const projectGraph = await (0, project_graph_1.createProjectGraphAsync)();
     const opts = parseRunOneOptions(cwd, args, projectGraph, nxJson);

package/src/command-line/run/run.js

@@ -100,7 +100,6 @@ async function runExecutorInternal({ project, target, configuration }, overrides
             target: targetConfig,
             projectsConfigurations,
             nxJsonConfiguration,
-            workspace: { ...projectsConfigurations, ...nxJsonConfiguration },
             projectName: project,
             targetName: target,
             configurationName: configuration,

package/src/command-line/run-many/run-many.js

@@ -4,7 +4,6 @@ exports.runMany = runMany;
 exports.projectsToRun = projectsToRun;
 const run_command_1 = require("../../tasks-runner/run-command");
 const command_line_utils_1 = require("../../utils/command-line-utils");
-const command_line_utils_2 = require("../../utils/command-line-utils");
 const project_graph_utils_1 = require("../../utils/project-graph-utils");
 const connect_to_nx_cloud_1 = require("../connect/connect-to-nx-cloud");
 const perf_hooks_1 = require("perf_hooks");
@@ -12,7 +11,6 @@ const project_graph_1 = require("../../project-graph/project-graph");
 const configuration_1 = require("../../config/configuration");
 const output_1 = require("../../utils/output");
 const find_matching_projects_1 = require("../../utils/find-matching-projects");
-const workspace_configuration_check_1 = require("../../utils/workspace-configuration-check");
 const graph_1 = require("../graph/graph");
 async function runMany(args, extraTargetDependencies = {}, extraOptions = {
     excludeTaskDependencies: args.excludeTaskDependencies,
@@ -20,9 +18,8 @@ async function runMany(args, extraTargetDependencies = {}, extraOptions = {
 }) {
     perf_hooks_1.performance.mark('code-loading:end');
     perf_hooks_1.performance.measure('code-loading', 'init-local', 'code-loading:end');
-    (0, workspace_configuration_check_1.workspaceConfigurationCheck)();
     const nxJson = (0, configuration_1.readNxJson)();
-    const { nxArgs, overrides } = (0, command_line_utils_2.splitArgsIntoNxArgsAndOverrides)(args, 'run-many', { printWarnings: args.graph !== 'stdout' }, nxJson);
+    const { nxArgs, overrides } = (0, command_line_utils_1.splitArgsIntoNxArgsAndOverrides)(args, 'run-many', { printWarnings: args.graph !== 'stdout' }, nxJson);
     if (nxArgs.verbose) {
         process.env.NX_VERBOSE_LOGGING = 'true';
     }

package/src/command-line/yargs-utils/shared-options.js

@@ -81,9 +81,9 @@ function withRunOptions(yargs) {
         default: false,
     })
         .option('skipSync', {
+        describe: 'Skips running the sync generators associated with the tasks.',
         type: 'boolean',
-        // TODO(leo): add description and make it visible once it is stable
-        hidden: true,
+        default: false,
     })
         .options('cloud', {
         type: 'boolean',

package/src/config/misc-interfaces.d.ts

@@ -173,16 +173,12 @@ export interface ExecutorContext {
     target?: TargetConfiguration;
     /**
      * Projects config
-     *
-     * @todo(vsavkin): mark this as required for v17
      */
-    projectsConfigurations?: ProjectsConfigurations;
+    projectsConfigurations: ProjectsConfigurations;
     /**
      * The contents of nx.json.
-     *
-     * @todo(vsavkin): mark this as required for v17
      */
-    nxJsonConfiguration?: NxJsonConfiguration;
+    nxJsonConfiguration: NxJsonConfiguration;
     /**
      * The current working directory
      */
@@ -194,19 +190,11 @@ export interface ExecutorContext {
     /**
      * A snapshot of the project graph as
      * it existed when the Nx command was kicked off
-     *
-     * @todo(vsavkin) mark this required for v17
      */
-    projectGraph?: ProjectGraph;
+    projectGraph: ProjectGraph;
     /**
      * A snapshot of the task graph as
      * it existed when the Nx command was kicked off
      */
     taskGraph?: TaskGraph;
-    /**
-     * Deprecated. Use projectsConfigurations or nxJsonConfiguration
-     * The full workspace configuration
-     * @todo(vsavkin): remove after v17
-     */
-    workspace?: ProjectsConfigurations & NxJsonConfiguration;
 }

package/src/config/nx-json.d.ts

@@ -353,7 +353,8 @@ export interface NxJsonConfiguration<T = '*' | string[]> {
         appsDir?: string;
     };
     /**
-     * Available Task Runners
+     * @deprecated Custom task runners will no longer be supported in Nx 21. Use Nx Cloud or Nx Powerpack instead.
+     * Available Task Runners for Nx to use
      */
     tasksRunnerOptions?: {
         [tasksRunnerName: string]: {
@@ -463,9 +464,9 @@ export interface NxJsonConfiguration<T = '*' | string[]> {
      */
     sync?: NxSyncConfiguration;
     /**
-     * Enable the new experimental db based cache
+     * Use the legacy file system cache instead of the db cache
      */
-    enableDbCache?: boolean;
+    useLegacyCache?: boolean;
 }
 export type PluginConfiguration = string | ExpandedPluginConfiguration;
 export type ExpandedPluginConfiguration<T = unknown> = {

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

@@ -61,8 +61,6 @@ export declare enum DependencyType {
      */
     implicit = "implicit"
 }
-/** @deprecated this type will be removed in v16. Use {@link ProjectGraphProjectNode} or {@link ProjectGraphExternalNode} instead */
-export type ProjectGraphNode = ProjectGraphProjectNode | ProjectGraphExternalNode;
 /**
  * A node describing a project in a workspace
  */