Add additional options for generating imports (#1364)

* Add additional docs on options Signed-off-by: Steve Ayers <[email protected]> * Remove WKT Signed-off-by: Steve Ayers <[email protected]> * Format Signed-off-by: Steve Ayers <[email protected]> * Update MIGRATING.md Co-authored-by: Timo Stamm <[email protected]> Signed-off-by: Steve Ayers <[email protected]> * Update MIGRATING.md Co-authored-by: Timo Stamm <[email protected]> Signed-off-by: Steve Ayers <[email protected]> --------- Signed-off-by: Steve Ayers <[email protected]> Co-authored-by: Timo Stamm <[email protected]>
connectrpc · Dec 6, 2024 · 84a65b9 · 84a65b9
1 parent e409055
commit 84a65b9
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/MIGRATING.md b/MIGRATING.md
@@ -73,6 +73,7 @@ version: v2
 plugins:
   - local: protoc-gen-es
     out: src/gen
+    include_imports: true
     opt: target=ts
 - - local: protoc-gen-connect-es
 -   out: src/gen
@@ -88,6 +89,7 @@ plugins:
 - - remote: buf.build/bufbuild/es:v1.10.0
 + - remote: buf.build/bufbuild/es:v2.2.0
     out: src/gen
+    include_imports: true
     opt: target=ts
 - - remote: buf.build/connectrpc/es
 -   out: src/gen
@@ -108,6 +110,7 @@ version: v2
 plugins:
   - local: protoc-gen-es
     out: src/gen
+    include_imports: true
 ```
 
 With this option, `buf generate` will delete the contents of `src/gen` before generating code.
@@ -123,6 +126,7 @@ version: v2
 plugins:
  - local: protoc-gen-es
    out: src/gen
+   include_imports: true
    opt:
      - target=ts
 +    - import_extension=js
@@ -137,6 +141,7 @@ version: v2
 plugins:
   - local: protoc-gen-es
     out: src/gen
+    include_imports: true
     opt:
       - target=ts
 -     - import_extension=none
@@ -151,6 +156,14 @@ Now that dependencies and `buf.gen.yaml` are updated, the next step is to re-gen
 migration tool does not handle code generation, so be sure to do so in whatever
 way your project is configured. For example, `npx buf generate` or `npm run generate`.
 
+> [!NOTE]
+> Ensure that your `buf.gen.yaml` includes the following options to generate
+> code for imports.
+>
+> - `include_imports: true`
+
+See the [Gotchas](#the-new-plugins-generates-missing-imports) section for an explanation.
+
 ## Update your application code
 
 Now that dependencies are updated and new code is generated, let's go through the