fix: code review

Author: kczulko

docs/scala_proto_library.md

@@ -78,7 +78,7 @@ toolchain(
 | generators_opts                | `List of strings, optional`<br/>Additional protobuf options like 'grpc', 'flat_package' or 'scala3_sources'. |
 | blacklisted_protos            | `List of labels, optional`<br/>List of protobuf targets to exclude from recursive building. |
 | code_generator                | `Label, optional (has default)`<br/>Which code generator to use. A sensible default is provided. |
-| named_generators              | `String dict, optional` |
+| generators                    | `String dict, optional` |
 | extra_generator_dependencies  | `List of labels, optional` |
 | scalac                        | `Label, optional (has default)`<br/>Target for scalac. A sensible default is provided. |
 

scala_proto/scala_proto_toolchain.bzl

@@ -27,7 +27,7 @@ def _worker_flags(ctx, generators, jars):
     return "--jvm_flags=" + " ".join(["-D%s=%s" % i for i in env.items()])
 
 def _scala_proto_toolchain_impl(ctx):
-    generators = ctx.attr.named_generators
+    generators = ctx.attr.generators
     generators_jars = _generators_jars(ctx)
     compile_dep_ids = ["scalapb_compile_deps"]
     toolchain = platform_common.ToolchainInfo(
@@ -57,18 +57,7 @@ scala_proto_toolchain = rule(
             default = Label("//src/scala/scripts:scalapb_worker"),
             allow_files = True,
         ),
-        # `scripts.ScalaPbCodeGenerator` and `_main_generator_dep` are currently
-        # necessary to support protoc-bridge < 0.9.8, specifically 0.7.14
-        # required by Scala 2.11. See #1647 and scalapb/ScalaPB#1771.
-        #
-        # If we drop 2.11 support, restore `scalapb.ScalaPbCodeGenerator` here,
-        # remove `_main_generator_dep`, and delete
-        # `//src/scala/scripts:scalapb_codegenerator_wrapper` and its files.
-        "named_generators": attr.string_dict(
-            default = {
-                "scala": "scripts.ScalaPbCodeGenerator",
-            },
-        ),
+        "generators": attr.string_dict(),
         "generators_opts": attr.string_list_dict(),
         "extra_generator_dependencies": attr.label_list(
             providers = [JavaInfo],
@@ -96,6 +85,13 @@ scala_proto_toolchain = rule(
             [proto rules documentation](https://docs.bazel.build/versions/master/be/protocol-buffer.html#proto_library)
             """,
         ),
+        # `scripts.ScalaPbCodeGenerator` and `_main_generator_dep` are currently
+        # necessary to support protoc-bridge < 0.9.8, specifically 0.7.14
+        # required by Scala 2.11. See #1647 and scalapb/ScalaPB#1771.
+        #
+        # If we drop 2.11 support, restore `scalapb.ScalaPbCodeGenerator` here,
+        # remove `_main_generator_dep`, and delete
+        # `//src/scala/scripts:scalapb_codegenerator_wrapper` and its files.
         "_main_generator_dep": attr.label(
             default = Label(
                 "//src/scala/scripts:scalapb_codegenerator_wrapper",
@@ -107,6 +103,24 @@ scala_proto_toolchain = rule(
     },
 )
 
+def scalapb_toolchain(name, opts = [], **kwargs):
+    """Setups default scala protobuf (scalapb) toolchain
+
+    Args:
+    name: A unique name for this target
+    opts: scalapb generator options like 'grpc' or 'flat_package'
+    """
+    scala_proto_toolchain(
+        name = name,
+        generators = {
+            "scala": "scripts.ScalaPbCodeGenerator",
+        },
+        generators_opts = {
+            "scala": opts
+        },
+        **kwargs,
+    )
+
 def _scala_proto_deps_toolchain(ctx):
     toolchain = platform_common.ToolchainInfo(
         dep_providers = ctx.attr.dep_providers,
@@ -125,3 +139,4 @@ scala_proto_deps_toolchain = rule(
 )
 
 scala_proto_deps_providers = _scala_proto_deps_providers
+

scala_proto/toolchains.bzl

@@ -1,7 +1,7 @@
 load(
     "//scala_proto:scala_proto_toolchain.bzl",
     "scala_proto_deps_toolchain",
-    "scala_proto_toolchain",
+    "scalapb_toolchain",
 )
 
 _default_gen_opts = [
@@ -36,12 +36,10 @@ def setup_scala_proto_toolchains(name, default_gen_opts = _default_gen_opts):
     toolchain_name = "%s_default_toolchain" % name
     toolchain_impl_name = "%s_default_toolchain_impl" % name
 
-    scala_proto_toolchain(
+    scalapb_toolchain(
         name = toolchain_impl_name,
+        opts = default_gen_opts,
         visibility = ["//visibility:public"],
-        generators_opts = {
-            "scala": default_gen_opts,
-        },
     )
 
     native.toolchain(

test/proto/BUILD

@@ -34,7 +34,7 @@ scala_proto_toolchain(
             "single_line_to_proto_string",
         ],
     },
-    named_generators = {
+    generators = {
         "scala": "scripts.ScalaPbCodeGenerator",
         "jvm_extra_protobuf_generator": "scalarules.test.extra_protobuf_generator.ExtraProtobufGenerator",
     },

test/proto/custom_generator/BUILD.bazel

@@ -62,7 +62,7 @@ toolchain(
 
 scala_proto_toolchain(
     name = "scala_proto_toolchain_def",
-    named_generators = {
+    generators = {
         "scala": "test.proto.custom_generator.DummyGenerator",
     },
 )
@@ -102,7 +102,7 @@ toolchain(
 
 scala_proto_toolchain(
     name = "failing_scala_proto_toolchain_def",
-    named_generators = {
+    generators = {
         "scala": "test.proto.custom_generator.FailingGenerator",
     },
 )