Add output_mode attr to select where files are written to

titanous · Sep 20, 2021 · eb9cd33 · eb9cd33
1 parent d143d46
commit eb9cd33
Show file tree

Hide file tree

Showing 24 changed files with 395 additions and 11 deletions.
diff --git a/doc/BUILD.bazel b/doc/BUILD.bazel
@@ -79,11 +79,11 @@ proto_plugin(
 proto_plugin(
     name = "template_plugin",
     out = "{name}",
-    separate_options_flag = True,
     quirks = [
         "QUIRK_OUT_PASS_ROOT",
         "QUIRK_DIRECT_MODE",
     ],
+    separate_options_flag = True,
     tool = select({
         "@bazel_tools//src/conditions:darwin_x86_64": "@protoc_gen_doc_darwin_x86_64//:protoc-gen-doc",
         "@bazel_tools//src/conditions:linux_x86_64": "@protoc_gen_doc_linux_x86_64//:protoc-gen-doc",

diff --git a/doc/doc_template_compile.bzl b/doc/doc_template_compile.bzl
@@ -6,7 +6,7 @@ load(
     "proto_compile_attrs",
     "proto_compile_impl",
 )
-load("//internal:compile.bzl", "proto_compile",)
+load("//internal:compile.bzl", "proto_compile")
 
 # Create compile rule
 def doc_template_compile_impl(ctx):
@@ -21,7 +21,8 @@ def doc_template_compile_impl(ctx):
 
     # Mutate args with template
     options["*"] = [
-        ctx.file.template.path, ctx.attr.name
+        ctx.file.template.path,
+        ctx.attr.name,
     ]
     extra_protoc_files += [ctx.file.template]
 

diff --git a/docs/lang/android.rst b/docs/lang/android.rst
@@ -108,6 +108,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -212,6 +217,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -330,6 +340,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
    * - ``deps``
      - ``label_list``
      - false
@@ -444,6 +459,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
    * - ``deps``
      - ``label_list``
      - false

diff --git a/docs/lang/c.rst b/docs/lang/c.rst
@@ -110,6 +110,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -203,6 +208,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
    * - ``deps``
      - ``label_list``
      - false

diff --git a/docs/lang/cpp.rst b/docs/lang/cpp.rst
@@ -108,6 +108,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -198,6 +203,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -292,6 +302,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
    * - ``deps``
      - ``label_list``
      - false
@@ -428,6 +443,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
    * - ``deps``
      - ``label_list``
      - false

diff --git a/docs/lang/csharp.rst b/docs/lang/csharp.rst
@@ -126,6 +126,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -233,6 +238,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -345,6 +355,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
    * - ``deps``
      - ``label_list``
      - false
@@ -453,6 +468,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
    * - ``deps``
      - ``label_list``
      - false

diff --git a/docs/lang/d.rst b/docs/lang/d.rst
@@ -110,6 +110,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -207,3 +212,8 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
diff --git a/docs/lang/doc.rst b/docs/lang/doc.rst
@@ -110,6 +110,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -201,6 +206,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -292,6 +302,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -383,6 +398,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -420,7 +440,8 @@ Full example project can be found `here <https://github.com/rules-proto-grpc/rul
    load("@rules_proto_grpc//doc:defs.bzl", "doc_template_compile")
    
    doc_template_compile(
-       name = "greeter_doc_proto",
+       name = "greeter_doc_proto.txt",
+       output_mode = "NO_PREFIX",
        protos = [
            "@rules_proto_grpc//example/proto:greeter_grpc",
            "@rules_proto_grpc//example/proto:thing_proto",
@@ -470,6 +491,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
    * - ``template``
      - ``label``
      - true

diff --git a/docs/lang/fsharp.rst b/docs/lang/fsharp.rst
@@ -126,6 +126,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -233,6 +238,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
 
 Plugins
 *******
@@ -344,6 +354,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
    * - ``deps``
      - ``label_list``
      - false
@@ -452,6 +467,11 @@ Attributes
      - false
      - ``[]``
      - List of labels that provide extra files to be available during protoc execution
+   * - ``output_mode``
+     - ``string``
+     - false
+     - ``PREFIXED``
+     - The output mode for the target. PREFIXED will output to a directory named by the target, NO_PREFIX will output to the current package.
    * - ``deps``
      - ``label_list``
      - false