Merge pull request #929 from ascopes/task/v5-deprecation-message

Warn users utilising deprecated parameters for protoc plugins

Author: ascopes

protobuf-maven-plugin/src/main/java/io/github/ascopes/protobufmavenplugin/mojo/AbstractGenerateMojo.java

@@ -900,6 +900,11 @@ public void execute() throws MojoExecutionException, MojoFailureException {
       return;
     }
 
+    reportDeprecatedProtocPluginsArgument(binaryMavenPlugins, "binaryMavenPlugin", "binary-maven");
+    reportDeprecatedProtocPluginsArgument(binaryPathPlugins, "binaryPathPlugin", "binary-path");
+    reportDeprecatedProtocPluginsArgument(binaryUrlPlugins, "binaryUrlPlugin", "binary-url");
+    reportDeprecatedProtocPluginsArgument(jvmMavenPlugins, "jvmMavenPlugin", "jvm-maven");
+
     var enabledLanguages = Language.setBuilder()
         .addIf(javaEnabled, Language.JAVA)
         .addIf(kotlinEnabled, Language.KOTLIN)
@@ -1026,4 +1031,40 @@ private <L> List<L> nonNullList(@Nullable List<L> list) {
   private <K, V> Map<K, V> nonNullMap(@Nullable Map<K, V> map) {
     return requireNonNullElseGet(map, Map::of);
   }
+
+  private void reportDeprecatedProtocPluginsArgument(
+      @Nullable Collection<?> arg,
+      String singularName,
+      String replacementKind
+  ) {
+    if (arg == null || arg.isEmpty()) {
+      return;
+    }
+
+    var before = String.join(
+        "\n",
+        "  <" + singularName + "s>",
+        "    <" + singularName + ">",
+        "      ...",
+        "    </" + singularName + ">",
+        "  </" + singularName + "s>"
+    );
+
+    var after = String.join(
+        "\n",
+        "  <protocPlugins>",
+        "    <protocPlugin kind=\"" + replacementKind + "\">",
+        "      ...",
+        "    </protocPlugin>",
+        "  </protocPlugins>"
+    );
+
+    log.warn(
+        "[DEPRECATED] The \"{}s\" attribute is deprecated for removal in v5.0.0. Please "
+            + "replace\n{}\n...with...\n{}\n moving forwards.",
+        singularName,
+        before,
+        after
+    );
+  }
 }