V2: Add GeneratedFile.array (#935)

bufbuild · Jul 19, 2024 · be86a73 · be86a73
1 parent ee20731
commit be86a73
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 13 deletions.
diff --git a/packages/protoc-gen-es/src/protoc-gen-es-plugin.ts b/packages/protoc-gen-es/src/protoc-gen-es-plugin.ts
@@ -29,12 +29,7 @@ import {
   type Schema,
   type Target,
 } from "@bufbuild/protoplugin";
-import {
-  arrayLiteral,
-  fieldJsonType,
-  fieldTypeScriptType,
-  functionCall,
-} from "./util";
+import { fieldJsonType, fieldTypeScriptType, functionCall } from "./util";
 import { version } from "../package.json";
 import { RawPluginOptions } from "@bufbuild/protoplugin/dist/cjs/parameter";
 
@@ -345,7 +340,7 @@ function getFileDescCall(f: GeneratedFile, file: DescFile, schema: Schema) {
     }));
     return functionCall(fileDesc, [
       f.string(info.base64()),
-      arrayLiteral(deps),
+      f.array(deps),
     ]);
   }
   return functionCall(fileDesc, [f.string(info.base64())]);

diff --git a/packages/protoc-gen-es/src/util.ts b/packages/protoc-gen-es/src/util.ts
@@ -230,10 +230,6 @@ export function functionCall(
   return [fn, ...tp, "(", commaSeparate(args), ")"];
 }
 
-export function arrayLiteral(elements: Printable[]): Printable {
-  return ["[", commaSeparate(elements), "]"];
-}
-
 function commaSeparate(elements: Printable[]): Printable {
   const r: Printable[] = [];
   for (let i = 0; i < elements.length; i++) {

diff --git a/packages/protoplugin-example/src/protoc-gen-twirp-es.ts b/packages/protoplugin-example/src/protoc-gen-twirp-es.ts
@@ -38,7 +38,7 @@ function generateTs(schema: Schema<PluginOptions>) {
     f.preamble(file);
     for (const service of file.services) {
       f.print(f.jsDoc(service));
-      f.print(f.export("class", safeIdentifier(service.name) + "Client"), " {");
+      f.print(f.export("class", safeIdentifier(service.name + "Client")), " {");
       f.print();
 
       // To support the custom option we defined in customoptions/default_host.proto,

diff --git a/packages/protoplugin-test/src/file-array.test.ts b/packages/protoplugin-test/src/file-array.test.ts
@@ -0,0 +1,32 @@
+// Copyright 2021-2024 Buf Technologies, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { describe, expect, test } from "@jest/globals";
+import type { Printable } from "@bufbuild/protoplugin";
+import { createTestPluginAndRun } from "./helpers.js";
+
+describe("GeneratedFile.array", () => {
+  test("creates an array literal", async () => {
+    const lines = await createTestPluginAndRun({
+      proto: `syntax="proto3";`,
+      parameter: "target=ts",
+      returnLinesOfFirstFile: true,
+      generateAny: (f) => {
+        const arr: Printable = f.array(["foo", 1, true]);
+        f.print(arr);
+      },
+    });
+    expect(lines).toStrictEqual(["[foo, 1, true]"]);
+  });
+});
diff --git a/packages/protoplugin/src/generated-file.ts b/packages/protoplugin/src/generated-file.ts
@@ -80,6 +80,11 @@ export interface GeneratedFile {
    */
   string(string: string): Printable;
 
+  /**
+   * Create an array literal.
+   */
+  array(elements: Printable[]): Printable;
+
   /**
    * Create a JSDoc comment block with the given text. Line breaks and white-space
    * stay intact.
@@ -238,6 +243,18 @@ export function createGeneratedFile(
         value: string,
       };
     },
+    array(elements) {
+      const p: Printable = [];
+      p.push("[");
+      for (const [index, element] of elements.entries()) {
+        p.push(element);
+        if (index < elements.length - 1) {
+          p.push(", ");
+        }
+      }
+      p.push("]");
+      return p;
+    },
     jsDoc(textOrSchema, indentation) {
       return {
         kind: "es_jsdoc",

diff --git a/packages/protoplugin/src/safe-identifier.ts b/packages/protoplugin/src/safe-identifier.ts
@@ -83,7 +83,11 @@ const reservedIdentifiers = new Set([
 ]);
 
 /**
- * Escapes names that are reserved identifiers in ECMAScript, TypeScript.
+ * Escapes reserved words in ECMAScript and TypeScript identifiers, by appending
+ * a dollar sign.
+ *
+ * This function is intended for use with identifiers from Protobuf. The passed
+ * string must be a valid identifier (e.g. not start with a digit).
  *
  * Also see safeObjectProperty() from @bufbuild/protoplugin/reflect.
  */