Build ourselves using GradleUtils 3.3.16

Author: Jonathing

build.gradle

@@ -6,20 +6,22 @@ plugins {
     id 'idea'
     id 'eclipse'
     id 'maven-publish'
-    //id 'io.freefair.javadoc-links'
-    id 'net.minecraftforge.gradleutils'
-    id 'net.minecraftforge.gitversion'
-    alias libs.plugins.changelog
+    alias libs.plugins.javadoc.links
+    alias libs.plugins.versions
     alias libs.plugins.licenser
+    alias libs.plugins.gradleutils
+    alias libs.plugins.gitversion
+    alias libs.plugins.changelog
     alias libs.plugins.plugin.publish
     alias libs.plugins.shadow
 }
 
 gradleutils.displayName = 'Forge Gradle Utilities'
-description = 'Small collection of utilities for standardizing MinecraftForge gradle scripts'
-base.archivesName = 'gradleutils'
+description = "Small collection of utilities for standardizing Forge's buildscripts."
 group = 'net.minecraftforge'
-// version set by gitversion in settings.gradle
+version = gitversion.tagOffset
+
+println "Version: $version"
 
 java {
     toolchain.languageVersion = JavaLanguageVersion.of(17)

gradle.properties

@@ -6,9 +6,5 @@ org.gradle.configuration-cache=true
 org.gradle.configuration-cache.parallel=true
 org.gradle.configuration-cache.problems=warn
 
-systemProp.org.gradle.unsafe.suppress-gradle-api=true
-
 net.minecraftforge.gradleutils.ide.automatic.sources=true
 net.minecraftforge.gradleutils.compilation.defaults=true
-
-net.minecraftforge.gitversion.log.version=true

gradleutils-shared/build.gradle

@@ -7,17 +7,19 @@ plugins {
     id 'idea'
     id 'eclipse'
     id 'maven-publish'
-    //id 'io.freefair.javadoc-links'
-    id 'net.minecraftforge.gradleutils'
+    alias libs.plugins.javadoc.links
+    alias libs.plugins.versions
     alias libs.plugins.licenser
+    alias libs.plugins.gradleutils
+    alias libs.plugins.gitversion
     alias libs.plugins.shadow
 }
 
 gradleutils.displayName = 'GradleUtils Shared'
 description = 'The shared base used by all of Forge\'s Gradle plugins.'
 base.archivesName = 'gradleutils-shared'
 group = 'net.minecraftforge'
-// version set by gitversion in settings.gradle
+version = gitversion.tagOffset
 
 java {
     toolchain.languageVersion = JavaLanguageVersion.of(17)

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

@@ -42,6 +42,7 @@
 import java.io.PipedInputStream;
 import java.io.PipedOutputStream;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.List;
 import java.util.Objects;
 import java.util.Set;
@@ -201,8 +202,10 @@ public static void ensureAfterEvaluate(Project project, Action<? super Project>
     ///
     /// This *does not* break the configuration cache as long as the task is always applied using this.
     ///
+    /// @param <T>     The type of task to be run
     /// @param project The project
-    /// @param task    The task to run first
+    /// @param task    The provider of the task to run first
+    /// @return The task provider
     public static <T extends TaskProvider<?>> T runFirst(Project project, T task) {
         // copy the requests because the backed list isn't concurrent
         var requests = new ArrayList<>(project.getGradle().getStartParameter().getTaskRequests());
@@ -306,13 +309,25 @@ public static Set<Dependency> collect(ConfigurationContainer configurations, Sou
 
     private static <T> void guardCheck(T t) { }
 
+    /// Iterates through the given source set's classpath configurations using the given action.
+    ///
+    /// @param configurations The configuration container
+    /// @param sourceSet      The source set
+    /// @param action         The action to run
+    /// @see #forEach(DomainObjectCollection, Action)
     public static void forEachClasspath(ConfigurationContainer configurations, SourceSet sourceSet, Action<? super Configuration> action) {
         forEach(configurations.named(
             name -> name.equals(sourceSet.getCompileClasspathConfigurationName())
                 || name.equals(sourceSet.getRuntimeClasspathConfigurationName())
         ), action);
     }
 
+    /// Iterates through the given source set's classpath configurations eagerly using the given action.
+    ///
+    /// @param configurations The configuration container
+    /// @param sourceSet      The source set
+    /// @param action         The action to run
+    /// @see #forEachEagerly(DomainObjectCollection, Action)
     public static void forEachClasspathEagerly(ConfigurationContainer configurations, SourceSet sourceSet, Action<? super Configuration> action) {
         forEachEagerly(configurations.named(
             name -> name.equals(sourceSet.getCompileClasspathConfigurationName())
@@ -322,6 +337,16 @@ public static void forEachClasspathEagerly(ConfigurationContainer configurations
     //endregion
 
     //region Domain Object Handling
+
+    /// Iterates through the given collection using the given action.
+    ///
+    /// This iterator will attempt to use [DomainObjectCollection#configureEach(Action)] if it is in an eager context.
+    /// If it is not, a [copy of][List#copyOf(Collection)] the collection will be iterated through using
+    /// [List#forEach(Consumer)] instead to prevent a [java.util.ConcurrentModificationException].
+    ///
+    /// @param <T>        The type for the collection
+    /// @param collection The collection to iterate through
+    /// @param action     The action to run
     public static <T> void forEach(DomainObjectCollection<T> collection, Action<? super T> action) {
         boolean eager = false;
         try {
@@ -331,12 +356,20 @@ public static <T> void forEach(DomainObjectCollection<T> collection, Action<? su
         }
 
         if (eager) {
-            collection.forEach(action::execute);
+            List.copyOf(collection).forEach(action::execute);
         } else {
             collection.configureEach(action);
         }
     }
 
+    /// Iterates through the given collection eagerly using the given action.
+    ///
+    /// This iterator will iterate over a [copy of][List#copyOf(Collection)] the collection using
+    /// [List#forEach(Consumer)] to prevent a [java.util.ConcurrentModificationException].
+    ///
+    /// @param <T>        The type for the collection
+    /// @param collection The collection to iterate through
+    /// @param action     The action to run
     public static <T> void forEachEagerly(DomainObjectCollection<T> collection, Action<? super T> action) {
         List.copyOf(collection).forEach(action::execute);
     }
@@ -347,6 +380,7 @@ public static <T> void forEachEagerly(DomainObjectCollection<T> collection, Acti
     /// Creates an output stream that logs to the given action.
     ///
     /// @param logger The logger to log to
+    /// @param level  The log level to log at
     /// @return The output stream
     public static PipedOutputStream toLog(Logger logger, LogLevel level) {
         return toLog(s -> logger.log(level, s));

settings.gradle

@@ -1,44 +1,41 @@
-pluginManagement {
-    repositories {
-        mavenCentral()
-        gradlePluginPortal()
-        maven { url = 'https://maven.minecraftforge.net/' }
-        //mavenLocal()
-    }
-}
-
 plugins {
-    id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0' // https://plugins.gradle.org/plugin/org.gradle.toolchains.foojay-resolver-convention
-
-    // NOTE: We need to load this into the classpath before GradleUtils for the service to load correctly
-    id 'io.freefair.javadoc-links' version '8.14' apply false // https://plugins.gradle.org/plugin/io.freefair.javadoc-links
-
-    id 'net.minecraftforge.gradleutils' version '3.2.25' // https://plugins.gradle.org/plugin/net.minecraftforge.gradleutils
-    id 'net.minecraftforge.gitversion'  version '3.0.7'  // https://plugins.gradle.org/plugin/net.minecraftforge.gitversion
+    id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0'
 }
 
 rootProject.name = 'gradleutils'
 
 include 'gradleutils-shared'
 
-dependencyResolutionManagement {
-    repositories {
-        mavenCentral()
-        gradlePluginPortal()
-        maven gradleutils.forgeMaven
-        maven { url = 'https://maven.moddinglegacy.com' } // Gradle API
-        //mavenLocal()
+// Applying plugins causes them to not have any IDE support when also applied to any build.gradle files
+// The workaround for now is to use this listener here so that it can stay in settings.gradle
+// See: https://youtrack.jetbrains.com/issue/IDEA-332061/Gradle-Missing-Code-Completion-Suggestions-for-Settings-Plugins-in-Groovy-DSL
+gradle.beforeProject { Project project ->
+    project.pluginManager.withPlugin('net.minecraftforge.gradleutils') {
+        project.repositories {
+            mavenCentral()
+            gradlePluginPortal()
+            maven project.gradleutils.forgeMaven
+            maven { url = 'https://maven.moddinglegacy.com' } // Gradle API
+            //mavenLocal()
+        }
     }
+}
 
+//@formatter:off
+dependencyResolutionManagement {
     versionCatalogs {
         register('libs') {
             version 'gradle-javadoc-links', '8.14'
-            version 'gradle-versions', '0.53.0'
+            version 'gradle-versions',      '0.53.0'
 
-            plugin 'licenser',       'net.minecraftforge.licenser'  version '1.2.0' // https://plugins.gradle.org/plugin/net.minecraftforge.licenser
-            plugin 'changelog',      'net.minecraftforge.changelog' version '3.0.6' // https://plugins.gradle.org/plugin/net.minecraftforge.changelog
-            plugin 'plugin-publish', 'com.gradle.plugin-publish'    version '1.3.1' // https://plugins.gradle.org/plugin/com.gradle.plugin-publish
-            plugin 'shadow',         'com.gradleup.shadow'          version '9.0.2' // https://plugins.gradle.org/plugin/com.gradleup.shadow
+            plugin 'javadoc-links',  'io.freefair.javadoc-links'      versionRef 'gradle-javadoc-links'
+            plugin 'versions',       'com.github.ben-manes.versions'  versionRef 'gradle-versions'
+            plugin 'licenser',       'net.minecraftforge.licenser'    version '1.2.0'
+            plugin 'gradleutils',    'net.minecraftforge.gradleutils' version '3.3.16'
+            plugin 'gitversion',     'net.minecraftforge.gitversion'  version '3.1.1'
+            plugin 'changelog',      'net.minecraftforge.changelog'   version '3.1.2'
+            plugin 'plugin-publish', 'com.gradle.plugin-publish'      version '2.0.0'
+            plugin 'shadow',         'com.gradleup.shadow'            version '9.2.2'
 
             // Static Analysis
             library 'nulls',  'org.jetbrains', 'annotations' version '26.0.2'
@@ -70,3 +67,4 @@ dependencyResolutionManagement {
         }
     }
 }
+//@formatter:on

src/main/groovy/net/minecraftforge/gradleutils/GradleUtilsExtensionForProject.java

@@ -33,19 +33,30 @@ public sealed interface GradleUtilsExtensionForProject extends GradleUtilsExtens
     /// @return The property for the vendor
     Property<String> getVendor();
 
+    /// Sets the default attributes for the given manifest and attaches the given package name as the section name.
+    ///
+    /// @param manifest    The manifest to apply defaults to
+    /// @param packageName The package name to use as the section name
     default void manifestDefaults(Manifest manifest, String packageName) {
         this.manifestDefaults(manifest, packageName, Map.of());
     }
 
+    /// Sets the default attributes for the given manifest and attaches the given package name as the section name.
+    ///
+    /// @param manifest          The manifest to apply defaults to
+    /// @param packageName       The package name to use as the section name
+    /// @param additionalEntries A map of additional entries to add
+    /// @apiNote GradleUtils will automatically attempt to [GradleUtilsExtension#unpack] any [values][Map#values()] in
+    /// the maps.
     void manifestDefaults(Manifest manifest, String packageName, Map<? extends CharSequence, ?> additionalEntries);
 
     /// Applies known defaults for Minecraft Forge's Gradle plugins.
     ///
     /// - For all configurations that
     /// {@linkplain org.codehaus.groovy.runtime.StringGroovyMethods#containsIgnoreCase(CharSequence, CharSequence)
     /// contain (ignoring case)} "runtimeElements", the
-    /// [org.gradle.api.attributes.plugin.GradlePluginApiVersion#GRADLE_PLUGIN_API_VERSION_ATTRIBUTE] attribute with
-    /// the value of the given Gradle version.
+    /// [org.gradle.api.attributes.plugin.GradlePluginApiVersion#GRADLE_PLUGIN_API_VERSION_ATTRIBUTE] attribute with the
+    /// value of the given Gradle version.
     ///
     /// @param configurations The configurations container to apply defaults to
     /// @param gradleVersion  The Gradle version to target
@@ -56,8 +67,8 @@ default void manifestDefaults(Manifest manifest, String packageName) {
     /// - For all configurations that
     /// {@linkplain org.codehaus.groovy.runtime.StringGroovyMethods#containsIgnoreCase(CharSequence, CharSequence)
     /// contain (ignoring case)} "runtimeElements", the
-    /// [org.gradle.api.attributes.plugin.GradlePluginApiVersion#GRADLE_PLUGIN_API_VERSION_ATTRIBUTE] attribute with
-    /// the value of the given Gradle version.
+    /// [org.gradle.api.attributes.plugin.GradlePluginApiVersion#GRADLE_PLUGIN_API_VERSION_ATTRIBUTE] attribute with the
+    /// value of the given Gradle version.
     ///
     /// @param configurations The configurations container to apply defaults to
     /// @param gradleVersion  The Gradle version to target
@@ -68,8 +79,8 @@ default void manifestDefaults(Manifest manifest, String packageName) {
     /// - For all configurations that
     /// {@linkplain org.codehaus.groovy.runtime.StringGroovyMethods#containsIgnoreCase(CharSequence, CharSequence)
     /// contain (ignoring case)} "runtimeElements", the
-    /// [org.gradle.api.attributes.plugin.GradlePluginApiVersion#GRADLE_PLUGIN_API_VERSION_ATTRIBUTE] attribute with
-    /// the value of the given Gradle version.
+    /// [org.gradle.api.attributes.plugin.GradlePluginApiVersion#GRADLE_PLUGIN_API_VERSION_ATTRIBUTE] attribute with the
+    /// value of the given Gradle version.
     ///
     /// @param configurations The configurations container to apply defaults to
     /// @param gradleVersion  The Gradle version to target