feat(monorepo): option to build with nx (#834)

feat(monorepo): build with nx

Author: mrgrain

API.md

@@ -44,6 +44,16 @@ export function generateYarnMonorepoOptions(project: typescript.TypeScriptProjec
           default: 'false',
         },
       },
+      {
+        name: 'buildWithNx',
+        optional: true,
+        type: { primitive: PrimitiveType.Boolean },
+        docs: {
+          summary: 'When Nx is enabled, always build the monorepo using Nx',
+          remarks: 'Will build projects in parallel and can improve build performance',
+          default: 'false',
+        },
+      },
       {
         name: 'release',
         optional: true,
@@ -131,6 +141,16 @@ export function generateYarnMonorepoOptions(project: typescript.TypeScriptProjec
           default: 'true',
         },
       },
+      {
+        name: 'buildWithNx',
+        optional: true,
+        type: { primitive: PrimitiveType.Boolean },
+        docs: {
+          summary: 'Build the monorepo using Nx during the release.',
+          remarks: 'Will build projects in parallel and can improve build performance',
+          default: 'false',
+        },
+      },
     ],
   });
 

projenrc/yarn-monorepo-options.ts

@@ -23,6 +23,7 @@ export class MonorepoRelease extends Component {
   private readonly branchName: string;
   private readonly github: github.GitHub;
   private readonly releaseTrigger: projenRelease.ReleaseTrigger;
+  private readonly buildWithNx: boolean;
   private readonly packagesToRelease = new Array<{
     readonly workspaceDirectory: string;
     readonly release: {
@@ -46,6 +47,7 @@ export class MonorepoRelease extends Component {
     }
     this.github = gh;
     this.releaseTrigger = options.releaseTrigger ?? projenRelease.ReleaseTrigger.continuous();
+    this.buildWithNx = options.buildWithNx ?? false;
   }
 
   public workspaceRelease(project: TypeScriptWorkspace) {
@@ -200,7 +202,12 @@ export class MonorepoRelease extends Component {
     // time so that the dependency versions in all 'package.json's are correct.
     this.releaseTask.exec('yarn workspaces run shx rm -rf dist');
     this.releaseTask.exec('yarn workspaces run bump');
-    this.releaseTask.exec('yarn workspaces run build');
+    if (this.buildWithNx) {
+      this.releaseTask.exec('nx run-many -t build');
+      this.releaseTask.env('NX_SKIP_NX_CACHE', 'true');
+    } else {
+      this.releaseTask.exec('yarn workspaces run build');
+    }
     this.releaseTask.exec('yarn workspaces run unbump');
     // anti-tamper check (fails if there were changes to committed files)
     // this will identify any non-committed files generated during build (e.g. test snapshots)

src/yarn/monorepo-options.ts

@@ -1,5 +1,5 @@
 import * as pathPosix from 'node:path/posix';
-import { JsonFile, Project, javascript, typescript, github, DependencyType } from 'projen';
+import { JsonFile, Project, javascript, typescript, github, DependencyType, JsonPatch } from 'projen';
 import { MonorepoOptions } from './monorepo-options';
 import { MonorepoRelease } from './monorepo-release';
 import { Nx } from './nx';
@@ -15,6 +15,9 @@ export class Monorepo extends typescript.TypeScriptProject {
     return Boolean(x && typeof x === 'object' && MONOREPO_SYM in x);
   }
 
+  /**
+   * The Monorepo Release component
+   */
   public readonly monorepoRelease?: MonorepoRelease;
 
   /**
@@ -38,6 +41,7 @@ export class Monorepo extends typescript.TypeScriptProject {
     Object.defineProperty(this, MONOREPO_SYM, { value: true });
 
     this.repositoryUrl = options.repository;
+    const buildWithNx = Boolean(options.nx && options.buildWithNx);
 
     /**
      * Prettier formatting
@@ -121,7 +125,14 @@ export class Monorepo extends typescript.TypeScriptProject {
     if (fmtTask) {
       buildTask.spawn(fmtTask);
     }
-    buildTask.exec('yarn workspaces run build');
+    if (buildWithNx) {
+      buildTask.exec('nx run-many -t build');
+      this.github?.tryFindWorkflow('build')?.file?.patch(
+        JsonPatch.add('/jobs/build/env/NX_SKIP_NX_CACHE', 'true'),
+      );
+    } else {
+      buildTask.exec('yarn workspaces run build');
+    }
 
     // Run in all workspaces tasks
     this.tasks.tryFind('compile')?.reset('yarn workspaces run compile');
@@ -166,6 +177,7 @@ export class Monorepo extends typescript.TypeScriptProject {
     if (options.release) {
       this.monorepoRelease = new MonorepoRelease(this, {
         workflowRunsOn: options.workflowRunsOn,
+        buildWithNx,
         ...options.releaseOptions,
       });
     }

src/yarn/monorepo-release-options.ts

@@ -56,20 +56,12 @@ export class Nx extends Component {
     project.addPackageIgnore('/.nx');
     new JsonFile(project, 'nx.json', {
       obj: {
-        tasksRunnerOptions: {
-          default: {
-            runner: 'nx/tasks-runners/default',
-            options: {
-              cacheableOperations: () =>
-                cachableTasks.map(({ name }) => name).filter((name) => project.tasks.tryFind(name)),
-            },
-          },
-        },
         targetDefaults: () =>
           cachableTasks.reduce((targetDefaults, { name, outputs, inputs }) => {
             const task = project.tasks.tryFind(name);
             if (task) {
               targetDefaults[name] = {
+                cache: true,
                 dependsOn: [`^${name}`],
                 outputs,
                 inputs,