Warn user when repositories are not ideally ordered

This adds two warnings:
1. Warn the user (at the ADVICE severity) to set Mavenizer as the topmost repository if it is not.
2. Warn the user (at the ERROR severity) to set Mavenizer higher than the Forge repository if it is not.

Author: Jonathing

src/main/java/net/minecraftforge/gradle/MinecraftExtension.java

@@ -25,7 +25,7 @@ public interface MinecraftExtension extends MinecraftMappingsContainer {
     String NAME = "minecraft";
 
     /**
-     * A closure for the generated Minecraft maven to be passed into
+     * A closure for the Minecraft Mavenizer's output to be passed into
      * {@link org.gradle.api.artifacts.dsl.RepositoryHandler#maven(Closure)}.
      * <p>Declaring this in your buildscript is <strong>required</strong> for the Minecraft dependencies to resolve
      * properly.</p>
@@ -36,7 +36,11 @@ public interface MinecraftExtension extends MinecraftMappingsContainer {
      * </code></pre>
      *
      * @return The closure
+     * @see #mavenizer(RepositoryHandler)
+     * @deprecated Use {@link #mavenizer(RepositoryHandler)} instead, as it has special handling to avoid pitfalls when
+     * including the mavenizer output in your repositories.
      */
+    @Deprecated(since = "7.0")
     Action<MavenArtifactRepository> getMavenizer();
 
     /**
@@ -47,6 +51,8 @@ public interface MinecraftExtension extends MinecraftMappingsContainer {
      *
      * @param repositories The repository handler to add the maven to
      * @return The Minecraft maven
+     * @apiNote This version includes special logic to avoid pitfalls when adding the Mavenizer output as a repository
+     * when using ForgeGradle in a subproject, for example, if all projects need to use the Forge maven.
      * @see #getMavenizer()
      */
     default MavenArtifactRepository mavenizer(RepositoryHandler repositories) {

src/main/java/net/minecraftforge/gradle/internal/ForgeGradleProblems.java

@@ -149,14 +149,27 @@ void mavenizerOutOfDate(boolean throwIt, Object dependency) {
             this.report(name, displayName, problemSpec);
     }
 
-    void reportCannotAccessSettingsRepos(Exception e) {
-        this.report("cannot-access-settings-repos", "Cannot access Settings repositories", spec -> spec
+    void reportMavenizerNotHighestRepository() {
+        this.report("mavenizer-not-highest-repo", "Mavenizer repository is not the highest", spec -> spec
             .details("""
-                ForgeGradle is unable to access the repositories defined by the Settings' dependency resolution management.
-                This is a ForgeGradle bug and needs to be reported to the ForgeGradle issue tracker on GitHub.""")
+                The Mavenizer repository is not the highest ranked repository for the project's repositories.
+                Any publicly consumable artifacts for Forge present in other repositories may be used instead of the generated artifacts by Mavenizer.
+                This may result in incorrect dependencies being consumed a "cannot resolve dependency" error.""")
+            .severity(Severity.ADVICE)
+            .solution("Declare Mavenizer's repository before any other repository.")
+            .solution("Use `minecraft.mavenizer(repositories)` instead of `repositories.maven(minecraft.mavenizer)`.")
+            .solution(HELP_MESSAGE));
+    }
+
+    void reportForgeAboveMavenizer() {
+        this.report("forge-maven-above-mavenizer", "Forge Maven has a higher priority than Mavenizer", spec -> spec
+            .details("""
+                The Forge Maven repository was found to have a higher priority for the project's repositories than Mavenizer.
+                The publicly consumable artifacts for Forge will be used instead of the generated artifacts by Mavenizer.
+                This will result in incorrect dependencies being consumed or a "cannot resolve dependency" error.""")
             .severity(Severity.ERROR)
-            .withException(e)
-            .solution("For now, only declare repositories in the project.")
+            .solution("Declare Mavenizer's repository before the Forge repository.")
+            .solution("Use `minecraft.mavenizer(repositories)` instead of `repositories.maven(minecraft.mavenizer)`.")
             .solution(HELP_MESSAGE));
     }
 

src/main/java/net/minecraftforge/gradle/internal/MinecraftExtensionImpl.java

@@ -56,6 +56,7 @@
 import java.util.Locale;
 import java.util.Objects;
 import java.util.function.Predicate;
+import java.util.function.ToIntFunction;
 import java.util.stream.Collectors;
 
 abstract class MinecraftExtensionImpl implements MinecraftExtensionInternal {
@@ -456,38 +457,44 @@ public Provider<ExternalModuleDependency> dependency(
         }
 
         private void checkRepos(List<? extends MavenArtifactRepository> repos) {
-            Predicate<String> contains = s -> {
-                for (var repo : repos) {
+            ToIntFunction<String> indexOf = s -> {
+                for (var i = 0; i < repos.size(); i++) {
+                    var repo = repos.get(i);
                     if (repo.getUrl().toString().contains(s))
-                        return true;
+                        return i;
                 }
 
-                return false;
+                return -1;
             };
 
-            Predicate<Object> containsExactly = object -> {
-                for (var repo : repos) {
-                    if (repo.getUrl().equals(ForProjectImpl.this.getProject().uri(object)))
-                        return true;
+            ToIntFunction<Object> indexOfExactly = object -> {
+                for (var i = 0; i < repos.size(); i++) {
+                    var repo = repos.get(i);
+                    if (repo.getUrl().equals(getProject().uri(object)))
+                        return i;
                 }
 
-                return false;
+                return -1;
             };
 
             // Mavenizer
-            if (!containsExactly.test(ForProjectImpl.this.getMavenizerOutput().getAsFile())) {
+            int mavenizer = indexOfExactly.applyAsInt(ForProjectImpl.this.getMavenizerOutput().getAsFile());
+            if (mavenizer < 0)
                 problems.reportMcMavenNotDeclared();
-            }
+            else if (mavenizer != 0) // if Mavenizer is not highest repository
+                problems.reportMavenizerNotHighestRepository();
 
             // Forge
-            if (!contains.test("maven.minecraftforge.net")) {
+            int forge = indexOf.applyAsInt("maven.minecraftforge.net");
+            if (forge < 0) {
                 problems.reportForgeMavenNotDeclared();
-            }
+            } else if (mavenizer > 0 && forge < mavenizer) // If Forge is above Mavenizer
+                problems.reportForgeAboveMavenizer();
 
             // Mojang
-            if (!contains.test("libraries.minecraft.net")) {
+            int mojang = indexOf.applyAsInt("libraries.minecraft.net");
+            if (mojang < 0)
                 problems.reportMcLibsMavenNotDeclared();
-            }
         }
     }
 }