Add additional options for generating imports (#243)

Including imports is not enabled by default in the Buf CLI. As a result, users have been getting tripped up on generating code when they have dependencies on protovalidate. This adds some additional guidance in our generating code docs to make sure they include imports since these should essentially always be included when generating with Protobuf-ES. --------- Signed-off-by: Steve Ayers <[email protected]>
connectrpc · Dec 5, 2024 · d69a15c · d69a15c
1 parent 1ec4ff4
commit d69a15c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/node/getting-started.md b/docs/node/getting-started.md
@@ -104,6 +104,8 @@ version: v2
 plugins:
   - local: protoc-gen-es
     out: gen
+    # Also generate any imported dependencies
+    include_imports: true
     opt: target=ts
 ```
 

diff --git a/docs/web/generating-code.mdx b/docs/web/generating-code.mdx
@@ -82,6 +82,8 @@ plugins:
   # This will invoke protoc-gen-es and write output to src/gen
   - local: protoc-gen-es
     out: src/gen
+    # Also generate any imported dependencies
+    include_imports: true
     # Add more plugin options here
     opt: target=ts
 ```