@nx/gradle 19.4.0-canary.20240621-472459d → 19.4.0-canary.20240626-3a2e8d4

package/migrations.json

@@ -1,4 +1,11 @@
 {
-  "generators": {},
+  "generators": {
+    "add-project-report-all": {
+      "version": "19.4.0-beta.1",
+      "cli": "nx",
+      "description": "Add task projectReportAll to build.gradle file",
+      "factory": "./src/migrations/19-4-0/add-project-report-all"
+    }
+  },
   "packageJsonUpdates": {}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/gradle",
-  "version": "19.4.0-canary.20240621-472459d",
+  "version": "19.4.0-canary.20240626-3a2e8d4",
   "private": false,
   "description": "The Nx Plugin for Gradle allows Gradle tasks to be run through Nx",
   "repository": {
@@ -34,7 +34,7 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "19.4.0-canary.20240621-472459d"
+    "@nx/devkit": "19.4.0-canary.20240626-3a2e8d4"
   },
   "publishConfig": {
     "access": "public"

package/src/generators/init/init.d.ts

@@ -1,4 +1,8 @@
 import { GeneratorCallback, Tree } from '@nx/devkit';
 import { InitGeneratorSchema } from './schema';
 export declare function initGenerator(tree: Tree, options: InitGeneratorSchema): Promise<GeneratorCallback>;
+/**
+ * This function creates and populate build.gradle file next to the settings.gradle file.
+ */
+export declare function addBuildGradleFileNextToSettingsGradle(tree: Tree): Promise<void>;
 export default initGenerator;

package/src/generators/init/init.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initGenerator = void 0;
+exports.addBuildGradleFileNextToSettingsGradle = exports.initGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
 const child_process_1 = require("child_process");
 const versions_1 = require("../../utils/versions");
 const has_gradle_plugin_1 = require("../../utils/has-gradle-plugin");
+const path_1 = require("path");
 async function initGenerator(tree, options) {
     const tasks = [];
     if (!tree.exists('settings.gradle') && !tree.exists('settings.gradle.kts')) {
@@ -18,9 +19,9 @@ Running 'gradle init':`);
             '@nx/gradle': versions_1.nxVersion,
         }, undefined, options.keepExistingVersions));
     }
+    await addBuildGradleFileNextToSettingsGradle(tree);
     addPlugin(tree);
     updateNxJsonConfiguration(tree);
-    addProjectReportToBuildGradle(tree);
     if (!options.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);
     }
@@ -43,23 +44,39 @@ function addPlugin(tree) {
     }
 }
 /**
- * This function adds the project-report plugin to the build.gradle or build.gradle.kts file
+ * This function creates and populate build.gradle file next to the settings.gradle file.
  */
-function addProjectReportToBuildGradle(tree) {
-    let buildGradleFile;
-    if (tree.exists('settings.gradle.kts')) {
-        buildGradleFile = 'build.gradle.kts';
-    }
-    else if (tree.exists('settings.gradle')) {
-        buildGradleFile = 'build.gradle';
+async function addBuildGradleFileNextToSettingsGradle(tree) {
+    const settingsGradleFiles = await (0, devkit_1.globAsync)(tree, [
+        '**/settings.gradle?(.kts)',
+    ]);
+    settingsGradleFiles.forEach((settingsGradleFile) => {
+        addProjectReportToBuildGradle(settingsGradleFile, tree);
+    });
+}
+exports.addBuildGradleFileNextToSettingsGradle = addBuildGradleFileNextToSettingsGradle;
+/**
+ * - creates a build.gradle file next to the settings.gradle file if it does not exist.
+ * - adds the project-report plugin to the build.gradle file if it does not exist.
+ * - adds a task to generate project reports for all subprojects and included builds.
+ */
+function addProjectReportToBuildGradle(settingsGradleFile, tree) {
+    const filename = (0, path_1.basename)(settingsGradleFile);
+    let gradleFilePath = 'build.gradle';
+    if (filename.endsWith('.kts')) {
+        gradleFilePath = 'build.gradle.kts';
     }
+    gradleFilePath = (0, path_1.join)((0, path_1.dirname)(settingsGradleFile), gradleFilePath);
     let buildGradleContent = '';
-    if (tree.exists(buildGradleFile)) {
-        buildGradleContent = tree.read(buildGradleFile).toString();
+    if (!tree.exists(gradleFilePath)) {
+        tree.write(gradleFilePath, buildGradleContent); // create a build.gradle file near settings.gradle file if it does not exist
+    }
+    else {
+        buildGradleContent = tree.read(gradleFilePath).toString();
     }
     if (buildGradleContent.includes('allprojects')) {
-        if (!buildGradleContent.includes('"project-report')) {
-            devkit_1.logger.warn(`Please add the project-report plugin to your ${buildGradleFile}:
+        if (!buildGradleContent.includes('"project-report"')) {
+            devkit_1.logger.warn(`Please add the project-report plugin to your ${gradleFilePath}:
 allprojects {
   apply {
       plugin("project-report")
@@ -73,7 +90,37 @@ allprojects {
       plugin("project-report")
   }
 }`;
-        tree.write(buildGradleFile, buildGradleContent);
+    }
+    if (!buildGradleContent.includes(`tasks.register("projectReportAll")`)) {
+        if (gradleFilePath.endsWith('.kts')) {
+            buildGradleContent += `\n\rtasks.register("projectReportAll") {
+    // All project reports of subprojects
+    allprojects.forEach {
+        dependsOn(it.tasks.get("projectReport"))
+    }
+
+    // All projectReportAll of included builds
+    gradle.includedBuilds.forEach {
+        dependsOn(it.task(":projectReportAll"))
+    }
+}`;
+        }
+        else {
+            buildGradleContent += `\n\rtasks.register("projectReportAll") {
+        // All project reports of subprojects
+        allprojects.forEach {
+            dependsOn(it.tasks.getAt("projectReport"))
+        }
+    
+        // All projectReportAll of included builds
+        gradle.includedBuilds.forEach {
+            dependsOn(it.task(":projectReportAll"))
+        }
+    }`;
+        }
+    }
+    if (buildGradleContent) {
+        tree.write(gradleFilePath, buildGradleContent);
     }
 }
 function updateNxJsonConfiguration(tree) {

package/src/migrations/19-4-0/add-project-report-all.d.ts

@@ -0,0 +1,5 @@
+import { Tree } from '@nx/devkit';
+/**
+ * This migration adds task `projectReportAll` to build.gradle files
+ */
+export default function update(tree: Tree): Promise<void>;

package/src/migrations/19-4-0/add-project-report-all.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const init_1 = require("../../generators/init/init");
+/**
+ * This migration adds task `projectReportAll` to build.gradle files
+ */
+async function update(tree) {
+    await (0, init_1.addBuildGradleFileNextToSettingsGradle)(tree);
+}
+exports.default = update;

package/src/plugin/dependencies.d.ts

@@ -1,2 +1,3 @@
-import { CreateDependencies } from '@nx/devkit';
+import { CreateDependencies, CreateDependenciesContext, RawProjectGraphDependency } from '@nx/devkit';
 export declare const createDependencies: CreateDependencies;
+export declare function processGradleDependencies(depsFile: string, gradleProjectToProjectName: Map<string, string>, sourceProjectName: string, gradleFile: string, context: CreateDependenciesContext, dependencies: Set<RawProjectGraphDependency>): void;

package/src/plugin/dependencies.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDependencies = void 0;
+exports.processGradleDependencies = exports.createDependencies = void 0;
 const devkit_1 = require("@nx/devkit");
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
@@ -10,20 +10,20 @@ const createDependencies = async (_, context) => {
     if (gradleFiles.length === 0) {
         return [];
     }
-    let dependencies = [];
     const gradleDependenciesStart = performance.mark('gradleDependencies:start');
     const { gradleFileToGradleProjectMap, gradleProjectToProjectName, buildFileToDepsMap, } = (0, get_gradle_report_1.getCurrentGradleReport)();
+    const dependencies = new Set();
     for (const gradleFile of gradleFiles) {
         const gradleProject = gradleFileToGradleProjectMap.get(gradleFile);
         const projectName = gradleProjectToProjectName.get(gradleProject);
         const depsFile = buildFileToDepsMap.get(gradleFile);
         if (projectName && depsFile) {
-            dependencies = dependencies.concat(Array.from(processGradleDependencies(depsFile, gradleProjectToProjectName, projectName, gradleFile, context)));
+            processGradleDependencies(depsFile, gradleProjectToProjectName, projectName, gradleFile, context, dependencies);
         }
     }
     const gradleDependenciesEnd = performance.mark('gradleDependencies:end');
     performance.measure('gradleDependencies', gradleDependenciesStart.name, gradleDependenciesEnd.name);
-    return dependencies;
+    return Array.from(dependencies);
 };
 exports.createDependencies = createDependencies;
 const gradleConfigFileNames = new Set(['build.gradle', 'build.gradle.kts']);
@@ -38,8 +38,7 @@ function findGradleFiles(fileMap) {
     }
     return gradleFiles;
 }
-function processGradleDependencies(depsFile, gradleProjectToProjectName, sourceProjectName, gradleFile, context) {
-    const dependencies = new Set();
+function processGradleDependencies(depsFile, gradleProjectToProjectName, sourceProjectName, gradleFile, context, dependencies) {
     const lines = (0, node_fs_1.readFileSync)(depsFile).toString().split(get_gradle_report_1.newLineSeparator);
     let inDeps = false;
     for (const line of lines) {
@@ -54,22 +53,31 @@ function processGradleDependencies(depsFile, gradleProjectToProjectName, sourceP
                 continue;
             }
             const [indents, dep] = line.split('--- ');
-            if ((indents === '\\' || indents === '+') && dep.startsWith('project ')) {
-                const gradleProjectName = dep
-                    .substring('project '.length)
-                    .replace(/ \(n\)$/, '')
-                    .trim();
+            if (indents === '\\' || indents === '+') {
+                let gradleProjectName;
+                if (dep.startsWith('project ')) {
+                    gradleProjectName = dep
+                        .substring('project '.length)
+                        .replace(/ \(n\)$/, '')
+                        .trim();
+                }
+                else if (dep.includes('-> project')) {
+                    const [_, projectName] = dep.split('-> project');
+                    gradleProjectName = projectName.trim();
+                }
                 const target = gradleProjectToProjectName.get(gradleProjectName);
-                const dependency = {
-                    source: sourceProjectName,
-                    target,
-                    type: devkit_1.DependencyType.static,
-                    sourceFile: gradleFile,
-                };
-                (0, devkit_1.validateDependency)(dependency, context);
-                dependencies.add(dependency);
+                if (target) {
+                    const dependency = {
+                        source: sourceProjectName,
+                        target,
+                        type: devkit_1.DependencyType.static,
+                        sourceFile: gradleFile,
+                    };
+                    (0, devkit_1.validateDependency)(dependency, context);
+                    dependencies.add(dependency);
+                }
             }
         }
     }
-    return dependencies;
 }
+exports.processGradleDependencies = processGradleDependencies;

package/src/utils/get-gradle-report.js

@@ -30,11 +30,32 @@ async function populateGradleReport(workspaceRoot) {
         return;
     }
     const gradleProjectReportStart = performance.mark('gradleProjectReport:start');
-    const projectReportLines = (await (0, exec_gradle_1.execGradleAsync)(['projectReport'], {
-        cwd: workspaceRoot,
-    }))
+    let projectReportLines;
+    try {
+        projectReportLines = await (0, exec_gradle_1.execGradleAsync)(['projectReportAll'], {
+            cwd: workspaceRoot,
+        });
+    }
+    catch (e) {
+        try {
+            projectReportLines = await (0, exec_gradle_1.execGradleAsync)(['projectReport'], {
+                cwd: workspaceRoot,
+            });
+            devkit_1.logger.warn('Could not run `projectReportAll` task. Ran `projectReport` instead. Please run `nx generate @nx/gradle:init` to generate the necessary tasks.');
+        }
+        catch (e) {
+            throw new devkit_1.AggregateCreateNodesError([
+                [
+                    null,
+                    new Error('Could not run `projectReportAll` or `projectReport` task. Please run `nx generate @nx/gradle:init` to generate the necessary tasks.'),
+                ],
+            ], []);
+        }
+    }
+    projectReportLines = projectReportLines
         .toString()
-        .split(exports.newLineSeparator);
+        .split(exports.newLineSeparator)
+        .filter((line) => line.trim() !== '');
     const gradleProjectReportEnd = performance.mark('gradleProjectReport:end');
     performance.measure('gradleProjectReport', gradleProjectReportStart.name, gradleProjectReportEnd.name);
     gradleReportCache = processProjectReports(projectReportLines);
@@ -45,10 +66,6 @@ function processProjectReports(projectReportLines) {
      * Map of Gradle File path to Gradle Project Name
      */
     const gradleFileToGradleProjectMap = new Map();
-    /**
-     * Map of Gradle Project Name to Gradle File
-     */
-    const gradleProjectToGradleFileMap = new Map();
     const dependenciesMap = new Map();
     /**
      * Map of Gradle Build File to tasks type map
@@ -115,7 +132,6 @@ function processProjectReports(projectReportLines) {
                 outputDirMap.set('classes', `{workspaceRoot}/${(0, node_path_1.join)(buildDir, 'classes')}`);
                 gradleFileToOutputDirsMap.set(buildFile, outputDirMap);
                 gradleFileToGradleProjectMap.set(buildFile, gradleProject);
-                gradleProjectToGradleFileMap.set(gradleProject, buildFile);
                 gradleProjectToProjectName.set(gradleProject, projectName);
             }
             if (line.endsWith('taskReport')) {