@nx/gradle 21.1.1 → 21.1.3

package/README.md

@@ -1,7 +1,7 @@
 <p style="text-align: center;">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-dark.svg">
-    <img alt="Nx - Smart Monorepos · Fast CI" src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-light.svg" width="100%">
+    <img alt="Nx - Smart Repos · Fast Builds" src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-light.svg" width="100%">
   </picture>
 </p>
 
@@ -22,9 +22,9 @@
 
 > Note: this plugin is currently experimental.
 
-# Nx: Smart Monorepos · Fast CI
+# Nx: Smart Repos · Fast Builds
 
-Nx is a build system, optimized for monorepos, with plugins for popular frameworks and tools and advanced CI capabilities including caching and distribution.
+An AI-first build platform that connects everything from your editor to CI. Helping you deliver fast, without breaking things.
 
 This package is a [Gradle plugin for Nx](https://nx.dev/gradle/overview).
 
@@ -66,5 +66,5 @@ npx nx@latest init
 - [Blog Posts About Nx](https://nx.dev/blog)
 
 <p style="text-align: center;"><a href="https://nx.dev/#learning-materials" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-courses-and-videos.svg" 
-width="100%" alt="Nx - Smart Monorepos · Fast CI"></a></p>
+width="100%" alt="Nx - Smart Repos · Fast Builds"></a></p>
 

package/migrations.json

@@ -29,6 +29,12 @@
       "cli": "nx",
       "description": "Change @nx/gradle option from ciTargetName to ciTestTargetName",
       "factory": "./src/migrations/21-0-0/change-ciTargetName-to-ciTestTargetName"
+    },
+    "change-plugin-version-0-1-0": {
+      "version": "21.1.2-beta.1",
+      "cli": "nx",
+      "description": "Change dev.nx.gradle.project-graph to version 0.1.0 in build file",
+      "factory": "./src/migrations/21-1-2/change-plugin-version-0-1-0"
     }
   },
   "packageJsonUpdates": {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/gradle",
-  "version": "21.1.1",
+  "version": "21.1.3",
   "private": false,
   "description": "The Nx Plugin for Gradle allows Gradle tasks to be run through Nx",
   "repository": {
@@ -35,7 +35,7 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "21.1.1"
+    "@nx/devkit": "21.1.3"
   },
   "publishConfig": {
     "access": "public"

package/src/generators/init/gradle-project-graph-plugin-utils.d.ts

@@ -0,0 +1,21 @@
+import { Tree } from '@nx/devkit';
+/**
+ * Adds a `build.gradle(.kts)` file next to each `settings.gradle(.kts)` file found in the workspace.
+ * If the build.gradle file already exists, it reads its contents.
+ */
+export declare function addBuildGradleFileNextToSettingsGradle(tree: Tree): Promise<{
+    filePath: string;
+    content: string;
+}[]>;
+/**
+ * Extract gradle plugin version from build.gradle file
+ */
+export declare function extractNxPluginVersion(gradleFilePath: string, gradleContent: string): Promise<string | null>;
+/**
+ * Updates the plugin version in the given Gradle file content.
+ */
+export declare function updateNxPluginVersion(content: string, newVersion: string): string;
+/**
+ * Ensures all build.gradle(.kts) files use the expected version of dev.nx.gradle.project-graph.
+ */
+export declare function addNxProjectGraphPlugin(tree: Tree, expectedVersion?: string): Promise<void>;

package/src/generators/init/gradle-project-graph-plugin-utils.js

@@ -0,0 +1,149 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addBuildGradleFileNextToSettingsGradle = addBuildGradleFileNextToSettingsGradle;
+exports.extractNxPluginVersion = extractNxPluginVersion;
+exports.updateNxPluginVersion = updateNxPluginVersion;
+exports.addNxProjectGraphPlugin = addNxProjectGraphPlugin;
+const devkit_1 = require("@nx/devkit");
+const versions_1 = require("../../utils/versions");
+const path_1 = require("path");
+const exec_gradle_1 = require("../../utils/exec-gradle");
+/**
+ * Adds a `build.gradle(.kts)` file next to each `settings.gradle(.kts)` file found in the workspace.
+ * If the build.gradle file already exists, it reads its contents.
+ */
+async function addBuildGradleFileNextToSettingsGradle(tree) {
+    const settingsGradleFiles = await (0, devkit_1.globAsync)(tree, [
+        '**/settings.gradle',
+        '**/settings.gradle.kts',
+    ]);
+    return settingsGradleFiles.map((settingsGradlePath) => {
+        return ensureBuildGradleFile(tree, settingsGradlePath);
+    });
+}
+/**
+ * Determines the appropriate build.gradle file path based on the settings file
+ * and ensures it exists in the tree. Returns the path and contents.
+ */
+function ensureBuildGradleFile(tree, settingsGradlePath) {
+    const isKotlinDsl = settingsGradlePath.endsWith('.kts');
+    const buildGradleFile = (0, path_1.join)((0, path_1.dirname)(settingsGradlePath), isKotlinDsl ? 'build.gradle.kts' : 'build.gradle');
+    let content = '';
+    if (tree.exists(buildGradleFile)) {
+        content = tree.read(buildGradleFile, 'utf-8');
+    }
+    else {
+        tree.write(buildGradleFile, content);
+    }
+    return { filePath: buildGradleFile, content };
+}
+// a regex to get the version in build file in format `id "dev.nx.gradle.project-graph" version "x"`
+const regex = /(id\s*\(?["']dev\.nx\.gradle\.project-graph["']\)?\s*version\s*\(?["'])([^"']+)(["']\)?)/;
+/**
+ * Extract gradle plugin version from build.gradle file
+ */
+async function extractNxPluginVersion(gradleFilePath, gradleContent) {
+    const match = gradleContent.match(regex);
+    let version = match ? match[2] : null;
+    if (!version) {
+        try {
+            const gradlewFile = (0, exec_gradle_1.findGradlewFile)(gradleFilePath, devkit_1.workspaceRoot);
+            const buildEnvironment = (await (0, exec_gradle_1.execGradleAsync)((0, path_1.join)(devkit_1.workspaceRoot, gradlewFile), [
+                'buildEnvironment',
+                '--quiet',
+            ])).toString();
+            version = getPluginVersion(buildEnvironment);
+        }
+        catch (e) { } // Silently ignore error, fallback remains null
+    }
+    return version;
+}
+function getPluginVersion(dependencyTree) {
+    const lines = dependencyTree.split('\n');
+    for (const line of lines) {
+        // line is dev.nx.gradle.project-graph:dev.nx.gradle.project-graph.gradle.plugin:version
+        const match = line.match(/dev\.nx\.gradle\.project-graph:dev\.nx\.gradle\.project-graph\.gradle\.plugin:([^\s\\]+)/);
+        if (match) {
+            return match[1]; // returns the version part
+        }
+    }
+    return null; // not found
+}
+/**
+ * Updates the plugin version in the given Gradle file content.
+ */
+function updateNxPluginVersion(content, newVersion) {
+    if (regex.test(content)) {
+        return content.replace(regex, `$1${newVersion}$3`);
+    }
+    else {
+        devkit_1.logger.warn(`Please update plugin dev.nx.gradle.project-graph to ${newVersion}`);
+    }
+    return content;
+}
+/**
+ * Ensures all build.gradle(.kts) files use the expected version of dev.nx.gradle.project-graph.
+ */
+async function addNxProjectGraphPlugin(tree, expectedVersion = versions_1.gradleProjectGraphVersion) {
+    const files = await addBuildGradleFileNextToSettingsGradle(tree);
+    files.forEach(({ filePath, content }) => {
+        addNxProjectGraphPluginToBuildGradle(filePath, content, expectedVersion, tree);
+    });
+}
+/**
+ * Adds or updates the Nx Project Graph plugin in the build.gradle(.kts) file.
+ * Ensures the correct version and applies the plugin to all projects.
+ * Returns the updated build.gradle content.
+ */
+async function addNxProjectGraphPluginToBuildGradle(gradleFilePath, buildGradleContent, expectedVersion = versions_1.gradleProjectGraphVersion, tree) {
+    const isKotlinDsl = gradleFilePath.endsWith('.kts');
+    const nxProjectGraphReportPlugin = isKotlinDsl
+        ? `id(\"${versions_1.gradleProjectGraphPluginName}\") version(\"${expectedVersion}\")`
+        : `id \"${versions_1.gradleProjectGraphPluginName}\" version \"${expectedVersion}\"`;
+    // Helper to add plugin to plugins block
+    function addPluginToPluginsBlock(content) {
+        return content.replace(/plugins\s*\{/, `plugins {\n    ${nxProjectGraphReportPlugin}`);
+    }
+    // Helper to add plugins block if missing
+    function addPluginsBlock(content) {
+        return `plugins {\n    ${nxProjectGraphReportPlugin}\n}\n${content}`;
+    }
+    // Helper to add plugin application to allprojects
+    function addPluginToAllProjects(content) {
+        const applyPlugin = isKotlinDsl
+            ? `plugin(\"${versions_1.gradleProjectGraphPluginName}\")`
+            : `plugin(\"${versions_1.gradleProjectGraphPluginName}\")`;
+        return `${content}\nallprojects {\n    apply {\n        ${applyPlugin}\n    }\n}`;
+    }
+    // 1. Ensure plugins block and correct plugin version
+    if (buildGradleContent.includes('plugins {')) {
+        if (buildGradleContent.includes(versions_1.gradleProjectGraphPluginName)) {
+            // Update version if needed
+            const currentVersion = await extractNxPluginVersion(gradleFilePath, buildGradleContent);
+            if (currentVersion && currentVersion !== expectedVersion) {
+                buildGradleContent = updateNxPluginVersion(buildGradleContent, expectedVersion);
+            }
+        }
+        else {
+            // Add plugin to plugins block
+            buildGradleContent = addPluginToPluginsBlock(buildGradleContent);
+        }
+    }
+    else {
+        // Add plugins block if missing
+        buildGradleContent = addPluginsBlock(buildGradleContent);
+    }
+    // 2. Ensure plugin is applied to all projects
+    const applyPluginPattern = new RegExp(`\\s*plugin\\(["']${versions_1.gradleProjectGraphPluginName}["']\\)`);
+    if (buildGradleContent.includes('allprojects {')) {
+        if (!applyPluginPattern.test(buildGradleContent)) {
+            devkit_1.logger.warn(`Please add the ${versions_1.gradleProjectGraphPluginName} plugin to your ${gradleFilePath}:\nallprojects {\n  apply {\n      plugin(\"${versions_1.gradleProjectGraphPluginName}\")\n  }\n}`);
+        }
+    }
+    else {
+        buildGradleContent = addPluginToAllProjects(buildGradleContent);
+    }
+    // 3. Write and return updated content
+    tree.write(gradleFilePath, buildGradleContent);
+    return buildGradleContent;
+}

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

@@ -1,9 +1,5 @@
 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 declare function updateNxJsonConfiguration(tree: Tree): void;
 export default initGenerator;

package/src/generators/init/init.js

@@ -1,12 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initGenerator = initGenerator;
-exports.addBuildGradleFileNextToSettingsGradle = addBuildGradleFileNextToSettingsGradle;
 exports.updateNxJsonConfiguration = updateNxJsonConfiguration;
 const devkit_1 = require("@nx/devkit");
 const versions_1 = require("../../utils/versions");
 const has_gradle_plugin_1 = require("../../utils/has-gradle-plugin");
-const path_1 = require("path");
+const gradle_project_graph_plugin_utils_1 = require("./gradle-project-graph-plugin-utils");
 async function initGenerator(tree, options) {
     const tasks = [];
     if (!options.skipPackageJson && tree.exists('package.json')) {
@@ -14,7 +13,7 @@ async function initGenerator(tree, options) {
             '@nx/gradle': versions_1.nxVersion,
         }, undefined, options.keepExistingVersions));
     }
-    await addBuildGradleFileNextToSettingsGradle(tree);
+    await (0, gradle_project_graph_plugin_utils_1.addNxProjectGraphPlugin)(tree);
     addPlugin(tree);
     updateNxJsonConfiguration(tree);
     if (!options.skipFormat) {
@@ -37,70 +36,6 @@ function addPlugin(tree) {
         (0, devkit_1.updateNxJson)(tree, nxJson);
     }
 }
-/**
- * This function creates and populate build.gradle file next to the settings.gradle file.
- */
-async function addBuildGradleFileNextToSettingsGradle(tree) {
-    const settingsGradleFiles = await (0, devkit_1.globAsync)(tree, [
-        '**/settings.gradle?(.kts)',
-    ]);
-    settingsGradleFiles.forEach((settingsGradleFile) => {
-        addNxProjectGraphPluginToBuildGradle(settingsGradleFile, tree);
-    });
-}
-/**
- * - creates a build.gradle file next to the settings.gradle file if it does not exist.
- * - adds the NxProjectGraphPlugin plugin to the build.gradle file if it does not exist.
- */
-function addNxProjectGraphPluginToBuildGradle(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(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();
-    }
-    const nxProjectGraphReportPlugin = filename.endsWith('.kts')
-        ? `id("${versions_1.gradleProjectGraphPluginName}") version("${versions_1.gradleProjectGraphVersion}")`
-        : `id "${versions_1.gradleProjectGraphPluginName}" version "${versions_1.gradleProjectGraphVersion}"`;
-    if (buildGradleContent.includes('plugins {')) {
-        if (!buildGradleContent.includes(versions_1.gradleProjectGraphPluginName)) {
-            buildGradleContent = buildGradleContent.replace('plugins {', `plugins {
-    ${nxProjectGraphReportPlugin}`);
-        }
-    }
-    else {
-        buildGradleContent = `plugins {
-    ${nxProjectGraphReportPlugin}
-}\n\r${buildGradleContent}`;
-    }
-    const applyNxProjectGraphReportPlugin = `plugin("${versions_1.gradleProjectGraphPluginName}")`;
-    if (buildGradleContent.includes('allprojects {')) {
-        if (!buildGradleContent.includes(`plugin("${versions_1.gradleProjectGraphPluginName}")`) &&
-            !buildGradleContent.includes(`plugin('${versions_1.gradleProjectGraphPluginName}')`)) {
-            devkit_1.logger.warn(`Please add the ${versions_1.gradleProjectGraphPluginName} plugin to your ${gradleFilePath}:
-allprojects {
-  apply {
-      ${applyNxProjectGraphReportPlugin}
-  }
-}`);
-        }
-    }
-    else {
-        buildGradleContent = `${buildGradleContent}\n\rallprojects {
-    apply {
-        ${applyNxProjectGraphReportPlugin}
-    }
-  }`;
-    }
-    tree.write(gradleFilePath, buildGradleContent);
-}
 function updateNxJsonConfiguration(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     if (!nxJson.namedInputs) {

package/src/migrations/21-1-2/change-plugin-version-0-1-0.d.ts

@@ -0,0 +1,2 @@
+import { Tree } from '@nx/devkit';
+export default function update(tree: Tree): Promise<void>;

package/src/migrations/21-1-2/change-plugin-version-0-1-0.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = update;
+const devkit_1 = require("@nx/devkit");
+const has_gradle_plugin_1 = require("../../utils/has-gradle-plugin");
+const gradle_project_graph_plugin_utils_1 = require("../../generators/init/gradle-project-graph-plugin-utils");
+/* Change the plugin version to 0.1.0
+ */
+async function update(tree) {
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    if (!nxJson) {
+        return;
+    }
+    if (!(0, has_gradle_plugin_1.hasGradlePlugin)(tree)) {
+        return;
+    }
+    await (0, gradle_project_graph_plugin_utils_1.addNxProjectGraphPlugin)(tree, '0.1.0');
+}