Don't use StartParameter in enhanced plugin

StartParameter isn't documented API and thus it's possible that Gradle
could change it in ways that could break plugins. Best not to use it and
assume what we do know (projects using `ProjectLayout`, settings using
`BuildLayout`, `Gradle#getGradleUserHomeDir`)

Author: Jonathing

README.md

@@ -16,6 +16,7 @@ helps us standardize our buildscripts.
 | 2.4.0 - 2.4.9  | 17   | 8.6    |
 | 2.4.10 - 2.5.x | 17   | 8.1*   |
 | 2.6.x          | 17   | 7.3    |
+| 3.x            | 17   | 9.0.0  |
 
 \*Compatibility was not tested for this version, but this is the lowest recommended version as it was built
 against it.

gradleutils-shared/README.md

@@ -0,0 +1,11 @@
+# GradleUtils Shared
+
+GradleUtils Shared is a shared plugin base used by all of Forge's Gradle
+plugins. This is meant to be a tool internal to Forge, but any one case use it
+if they want.
+
+> [!NOTE]
+> The version number is intentionally shared with base GradleUtils. However, it
+> may not always be published alongside it. Check the
+> [Forge Files Site](https://files.minecraftforge.net/net/minecraftforge/gradleutils-shared/index.html)
+> for the latest version before using it.

gradleutils-shared/build.gradle

@@ -15,7 +15,7 @@ plugins {
 }
 
 final projectDisplayName = 'Minecraft Forge Shared Plugin Base'
-final projectArtifactId = base.archivesName = 'gradleutils-shared'
+base.archivesName = 'gradleutils-shared'
 description = 'The shared base used by all of Minecraft Forge\'s Gradle plugins'
 group = 'net.minecraftforge'
 version = gitversion.tagOffset
@@ -90,7 +90,6 @@ publishing {
 
     publications.register('mavenJava', MavenPublication) {
         from components.java
-        artifactId = projectArtifactId
 
         pom { pom ->
             name = projectDisplayName

gradleutils-shared/src/main/java/net/minecraftforge/gradleutils/shared/EnhancedPlugin.java

@@ -5,11 +5,12 @@
 package net.minecraftforge.gradleutils.shared;
 
 import org.codehaus.groovy.runtime.InvokerHelper;
-import org.gradle.StartParameter;
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 import org.gradle.api.file.BuildLayout;
 import org.gradle.api.file.DirectoryProperty;
+import org.gradle.api.file.ProjectLayout;
+import org.gradle.api.initialization.Settings;
 import org.gradle.api.invocation.Gradle;
 import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.provider.Provider;
@@ -37,6 +38,13 @@ public abstract class EnhancedPlugin<T> implements Plugin<T>, EnhancedPluginAddi
     /// Service Injection</a>
     protected abstract @Inject ObjectFactory getObjects();
 
+    /// The project layout provided by Gradle services.
+    ///
+    /// @return The build layout
+    /// @see <a href="https://docs.gradle.org/current/userguide/service_injection.html#buildlayout">BuildLayout
+    /// Service Injection</a>
+    protected abstract @Inject ProjectLayout getProjectLayout();
+
     /// The build layout provided by Gradle services.
     ///
     /// @return The build layout
@@ -116,16 +124,16 @@ public final DirectoryProperty globalCaches() {
 
     private DirectoryProperty makeGlobalCaches() {
         try {
-            StartParameter startParameter = ((Gradle) InvokerHelper.getPropertySafe(this.target, "gradle")).getStartParameter();
-            DirectoryProperty gradleUserHomeDir = this.getObjects().directoryProperty().fileValue(startParameter.getGradleUserHomeDir());
+            Gradle gradle = ((Gradle) InvokerHelper.getProperty(this.target, "gradle"));
+            DirectoryProperty gradleUserHomeDir = this.getObjects().directoryProperty().fileValue(gradle.getGradleUserHomeDir());
 
             return this.getObjects().directoryProperty().convention(
                 gradleUserHomeDir.dir("caches/minecraftforge/" + this.name).map(this.problemsInternal.ensureFileLocation())
             );
         } catch (Exception e) {
             throw this.problemsInternal.illegalPluginTarget(
                 new IllegalArgumentException(String.format("Failed to get %s global caches directory for target: %s", this.displayName, this.target), e),
-                "types with access to Gradle (#getGradle()Lorg/gradle/api/invocation/Gradle), such as projects or settings."
+                "projects or settings"
             );
         }
     }
@@ -141,11 +149,11 @@ private DirectoryProperty makeLocalCaches() {
         try {
             DirectoryProperty workingProjectBuildDir;
             if (this.target instanceof Project) {
-                workingProjectBuildDir = ((Project) this.target).getLayout().getBuildDirectory();
+                workingProjectBuildDir = this.getProjectLayout().getBuildDirectory();
+            } else if (this.target instanceof Settings) {
+                workingProjectBuildDir = this.getObjects().directoryProperty().fileValue(new File(this.getBuildLayout().getRootDirectory().getAsFile(), "build"));
             } else {
-                StartParameter startParameter = ((Gradle) InvokerHelper.getPropertySafe(this.target, "gradle")).getStartParameter();
-                File projectDir = startParameter.getProjectDir();
-                workingProjectBuildDir = this.getObjects().directoryProperty().fileValue(new File(projectDir != null ? projectDir : this.getBuildLayout().getRootDirectory().getAsFile(), "build"));
+                throw new IllegalStateException("Cannot make local caches with an unsupported type (must be project or settings)");
             }
 
             return this.getObjects().directoryProperty().convention(
@@ -154,7 +162,32 @@ private DirectoryProperty makeLocalCaches() {
         } catch (Exception e) {
             throw this.problemsInternal.illegalPluginTarget(
                 new IllegalArgumentException(String.format("Failed to get %s local caches directory for target: %s", this.displayName, this.getTarget()), e),
-                "projects or types with access to Gradle (#getGradle()Lorg/gradle/api/invocation/Gradle), such as settings."
+                "projects or settings"
+            );
+        }
+    }
+
+    private final Lazy<DirectoryProperty> workingProjectDirectory = Lazy.simple(this::makeWorkingProjectDirectory);
+
+    @Override
+    public final DirectoryProperty workingProjectDirectory() {
+        return this.workingProjectDirectory.get();
+    }
+
+    private DirectoryProperty makeWorkingProjectDirectory() {
+        try {
+            DirectoryProperty workingProjectDirectory = this.getObjects().directoryProperty();
+            if (this.target instanceof Project) {
+                return workingProjectDirectory.value(this.getProjectLayout().getProjectDirectory());
+            } else if (this.target instanceof Settings) {
+                return workingProjectDirectory.value(this.getBuildLayout().getRootDirectory());
+            } else {
+                throw new IllegalStateException("Cannot get working project directory with an unsupported type (must be project or settings)");
+            }
+        } catch (Exception e) {
+            throw this.problemsInternal.illegalPluginTarget(
+                new IllegalArgumentException(String.format("Failed to get %s working project directory for target: %s", this.displayName, this.getTarget()), e),
+                "projects or settings"
             );
         }
     }

gradleutils-shared/src/main/java/net/minecraftforge/gradleutils/shared/EnhancedPluginAdditions.java

@@ -1,3 +1,7 @@
+/*
+ * Copyright (c) Forge Development LLC and contributors
+ * SPDX-License-Identifier: LGPL-2.1-only
+ */
 package net.minecraftforge.gradleutils.shared;
 
 import org.gradle.api.file.DirectoryProperty;
@@ -34,4 +38,16 @@ public interface EnhancedPluginAdditions {
     /// @throws RuntimeException If this plugin cannot access global caches (i.e. the target is not
     ///                          [org.gradle.api.Project] or [org.gradle.api.initialization.Settings])
     DirectoryProperty localCaches();
+
+    /// Gets the working project directory to be used for this plugin. This directory is either the
+    /// [org.gradle.api.file.ProjectLayout#getProjectDirectory()] of the [org.gradle.api.Project] or the
+    /// [org.gradle.api.file.BuildLayout#getRootDirectory()] of the [org.gradle.api.initialization.Settings]. Attempting
+    /// to call this when the plugin target is not either type will throw an exception.
+    ///
+    /// It is located in `project/build/minecraftforge/plugin`.
+    ///
+    /// @return The working project directory
+    /// @throws RuntimeException If this plugin cannot access the working project directory (i.e. the target is not
+    ///                          [org.gradle.api.Project] or [org.gradle.api.initialization.Settings])
+    DirectoryProperty workingProjectDirectory();
 }

gradleutils-shared/src/main/java/net/minecraftforge/gradleutils/shared/EnhancedTask.java

@@ -48,6 +48,11 @@ default DirectoryProperty localCaches() {
         return this.getPlugin().localCaches();
     }
 
+    @Override
+    default DirectoryProperty workingProjectDirectory() {
+        return this.getPlugin().workingProjectDirectory();
+    }
+
     /// The default output directory to use for this task if it outputs a directory.
     ///
     /// @return A provider for the directory

src/main/groovy/net/minecraftforge/gradleutils/PomUtilsImpl.groovy

@@ -9,6 +9,7 @@ import groovy.transform.CompileStatic
 import groovy.transform.PackageScope
 import net.minecraftforge.gradleutils.shared.SharedUtil
 import org.gradle.api.Project
+import org.gradle.api.UnknownDomainObjectException
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.plugins.ExtensionAware
 import org.gradle.api.publish.maven.MavenPom
@@ -46,12 +47,18 @@ import javax.inject.Inject
             // If GradleUtils were to depend on Git Version, even as compile-only, it might lead to cyclic dependency issues.
             // Editing the PomUtilsImpl meta-class from the Git Version plugin itself is too risky.
             // As such, this contract must ALWAYS be true:
-            // - Project contains an extension named 'gitversion'
+            // - Project or Gradle contains an extension named 'gitversion'
+            //   - Applying Git Version to Settings will add the extension to settings and gradle
             // - The extension contains method '#getUrl()' or property 'url'
-            this.target.extensions.getByName('gitversion').url
-
-            // IN CASE you need to migrate to Java, here is the Java equivalent of this, safe to compile:
-            //org.codehaus.groovy.runtime.InvokerHelper.getProperty(this.project.extensions.getByName("gitversion"), "url")
+            try {
+                this.target.extensions.getByName('gitversion').url
+            } catch (UnknownDomainObjectException e) {
+                try {
+                    this.target.gradle.extensions.getByName('gitversion').url
+                } catch (Exception suppressed) {
+                    throw e.tap { addSuppressed(suppressed) }
+                }
+            }
         } catch (Exception e) {
             throw this.problems.pomUtilsGitVersionMissing(e)
         }