feat: add generated code comments (#1037)

Closes #531
stephenh · May 1, 2024 · cdd4a76 · cdd4a76
1 parent 577def4
commit cdd4a76
Show file tree

Hide file tree

Showing 260 changed files with 1,587 additions and 22 deletions.
diff --git a/integration/angular/simple-message.ts b/integration/angular/simple-message.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: simple-message.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 

diff --git a/integration/async-iterable-services-abort-signal/simple.ts b/integration/async-iterable-services-abort-signal/simple.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: simple.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 

diff --git a/integration/async-iterable-services/simple.ts b/integration/async-iterable-services/simple.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: simple.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 

diff --git a/integration/avoid-import-conflicts-folder-name/ui.ts b/integration/avoid-import-conflicts-folder-name/ui.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: ui.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 

diff --git a/integration/avoid-import-conflicts-folder-name/ui/simple.ts b/integration/avoid-import-conflicts-folder-name/ui/simple.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: ui/simple.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 import {

diff --git a/integration/avoid-import-conflicts-types-only/simple.ts b/integration/avoid-import-conflicts-types-only/simple.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: simple.proto
+
 /* eslint-disable */
 import type { Simple as Simple2, SimpleEnum as SimpleEnum1 } from "./simple2";
 

diff --git a/integration/avoid-import-conflicts-types-only/simple2.ts b/integration/avoid-import-conflicts-types-only/simple2.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: simple2.proto
+
 /* eslint-disable */
 
 export const protobufPackage = "simple2";

diff --git a/integration/avoid-import-conflicts/simple.ts b/integration/avoid-import-conflicts/simple.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: simple.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 import {

diff --git a/integration/avoid-import-conflicts/simple2.ts b/integration/avoid-import-conflicts/simple2.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: simple2.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 

diff --git a/integration/barrel-imports/bar.ts b/integration/barrel-imports/bar.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: bar.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 

diff --git a/integration/barrel-imports/foo.ts b/integration/barrel-imports/foo.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: foo.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 import { Bar } from "./bar";

diff --git a/integration/batching-with-context-esModuleInterop/batching.ts b/integration/batching-with-context-esModuleInterop/batching.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: batching.proto
+
 /* eslint-disable */
 import DataLoader from "dataloader";
 import hash from "object-hash";

diff --git a/integration/batching-with-context/batching.ts b/integration/batching-with-context/batching.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: batching.proto
+
 /* eslint-disable */
 import * as DataLoader from "dataloader";
 import * as hash from "object-hash";

diff --git a/integration/batching/batching.ts b/integration/batching/batching.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: batching.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 

diff --git a/integration/before-after-request-streaming/example.ts b/integration/before-after-request-streaming/example.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: example.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 import { Observable } from "rxjs";

diff --git a/integration/before-after-request-streaming/google/protobuf/wrappers.ts b/integration/before-after-request-streaming/google/protobuf/wrappers.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: google/protobuf/wrappers.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 import Long = require("long");

diff --git a/integration/before-after-request/simple.ts b/integration/before-after-request/simple.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: simple.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 import {

diff --git a/integration/before-after-request/simple2.ts b/integration/before-after-request/simple2.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: simple2.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 

diff --git a/integration/bytes-as-base64-browser/message.ts b/integration/bytes-as-base64-browser/message.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: message.proto
+
 /* eslint-disable */
 
 export const protobufPackage = "";

diff --git a/integration/bytes-as-base64-node/message.ts b/integration/bytes-as-base64-node/message.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: message.proto
+
 /* eslint-disable */
 
 export const protobufPackage = "";

diff --git a/integration/bytes-as-base64/message.ts b/integration/bytes-as-base64/message.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: message.proto
+
 /* eslint-disable */
 
 export const protobufPackage = "";

diff --git a/integration/bytes-node/google/protobuf/wrappers.ts b/integration/bytes-node/google/protobuf/wrappers.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: google/protobuf/wrappers.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 import Long = require("long");

diff --git a/integration/bytes-node/point.ts b/integration/bytes-node/point.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: point.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 import { BytesValue } from "./google/protobuf/wrappers";

diff --git a/integration/codegen.ts b/integration/codegen.ts
@@ -4,7 +4,7 @@ import { parse } from "path";
 import { promisify } from "util";
 import { generateFile, makeUtils } from "../src/main";
 import { createTypeMap } from "../src/types";
-import { generateIndexFiles } from "../src/utils";
+import { generateIndexFiles, getVersions } from "../src/utils";
 import { getTsPoetOpts, optionsFromParameter } from "../src/options";
 import { BaseContext, createFileContext } from "../src/context";
 import { generateTypeRegistry } from "../src/generate-type-registry";
@@ -28,6 +28,8 @@ async function generate(binFile: string, baseDir: string, parameter: string) {
   const request = CodeGeneratorRequest.decode(stdin);
   request.parameter = parameter;
 
+  const { protocVersion, tsProtoVersion } = await getVersions(request);
+
   const options = optionsFromParameter(parameter || "");
   const typeMap = createTypeMap(request, options);
 
@@ -42,7 +44,10 @@ async function generate(binFile: string, baseDir: string, parameter: string) {
     const filePath = `${baseDir}/${path}`;
     const dirPath = parse(filePath).dir;
     await promisify(mkdir)(dirPath, { recursive: true }).catch(() => {});
-    await promisify(writeFile)(filePath, code.toString({ ...getTsPoetOpts(options), path }));
+    await promisify(writeFile)(
+      filePath,
+      code.toString({ ...getTsPoetOpts(options, tsProtoVersion, protocVersion, file.name), path }),
+    );
   }
 
   if (options.outputTypeRegistry) {
@@ -54,15 +59,21 @@ async function generate(binFile: string, baseDir: string, parameter: string) {
 
     const filePath = `${baseDir}/${path}`;
 
-    await promisify(writeFile)(filePath, code.toString({ ...getTsPoetOpts(options), path }));
+    await promisify(writeFile)(
+      filePath,
+      code.toString({ ...getTsPoetOpts(options, tsProtoVersion, protocVersion), path }),
+    );
   }
 
   if (options.outputIndex) {
     for (const [path, code] of generateIndexFiles(request.protoFile, options)) {
       const filePath = `${baseDir}/${path}`;
       const dirPath = parse(filePath).dir;
       await promisify(mkdir)(dirPath, { recursive: true }).catch(() => {});
-      await promisify(writeFile)(filePath, code.toString({ ...getTsPoetOpts(options), path }));
+      await promisify(writeFile)(
+        filePath,
+        code.toString({ ...getTsPoetOpts(options, tsProtoVersion, protocVersion), path }),
+      );
     }
   }
 }

diff --git a/integration/const-enum/const-enum.ts b/integration/const-enum/const-enum.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: const-enum.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 

diff --git a/integration/default-with-custom-metadata/default-with-custom-metadata.ts b/integration/default-with-custom-metadata/default-with-custom-metadata.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: default-with-custom-metadata.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 import { Foo } from "./custom-metadata";

diff --git a/integration/default-with-metadata/default-with-metadata.ts b/integration/default-with-metadata/default-with-metadata.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: default-with-metadata.proto
+
 /* eslint-disable */
 import { Metadata } from "@grpc/grpc-js";
 import * as _m0 from "protobufjs/minimal";

diff --git a/integration/emit-default-values-json/google/protobuf/timestamp.ts b/integration/emit-default-values-json/google/protobuf/timestamp.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: google/protobuf/timestamp.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 import Long = require("long");

diff --git a/integration/emit-default-values-json/test.ts b/integration/emit-default-values-json/test.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: test.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 import { Timestamp } from "./google/protobuf/timestamp";

diff --git a/integration/enums-as-literals-with-string-enums/enums-as-literals-with-string-enums.ts b/integration/enums-as-literals-with-string-enums/enums-as-literals-with-string-enums.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: enums-as-literals-with-string-enums.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 

diff --git a/integration/enums-as-literals/enums-as-literals.ts b/integration/enums-as-literals/enums-as-literals.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: enums-as-literals.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 

diff --git a/integration/enums-with-unrecognized-name-value/test.ts b/integration/enums-with-unrecognized-name-value/test.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: test.proto
+
 /* eslint-disable */
 
 export const protobufPackage = "";

diff --git a/integration/extensions/test.ts b/integration/extensions/test.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: test.proto
+
 /* eslint-disable */
 import Long = require("long");
 import * as _m0 from "protobufjs/minimal";

diff --git a/integration/fieldmask-optional-all/fieldmask-optional.ts b/integration/fieldmask-optional-all/fieldmask-optional.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: fieldmask-optional.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";
 import { FieldMask } from "./google/protobuf/field_mask";

diff --git a/integration/fieldmask-optional-all/google/protobuf/field_mask.ts b/integration/fieldmask-optional-all/google/protobuf/field_mask.ts
@@ -1,3 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.173.0
+//   protoc               v3.19.1
+// source: google/protobuf/field_mask.proto
+
 /* eslint-disable */
 import * as _m0 from "protobufjs/minimal";