refactor: parse options with protoplugin api (#427)

Author: izumin5210

.changeset/quick-tips-mix.md

@@ -0,0 +1,7 @@
+---
+"@proto-graphql/protoc-plugin-helpers": patch
+"protoc-gen-pothos": patch
+"protoc-gen-nexus": patch
+---
+
+refactor: parse options with protoplugin api

packages/@proto-graphql/protoc-plugin-helpers/src/index.ts

@@ -1 +1,3 @@
 export { createTsGenerator } from "./process";
+export { parseNexusOptions, parsePothosOptions } from "./options";
+export type { Options } from "./options";

…c-plugin-helpers/src/parseParams.test.ts …rotoc-plugin-helpers/src/options.test.tspackages/@proto-graphql/protoc-plugin-helpers/src/parseParams.test.ts renamed to packages/@proto-graphql/protoc-plugin-helpers/src/options.test.ts packages/@proto-graphql/protoc-plugin-helpers/src/parseParams.test.ts renamed to packages/@proto-graphql/protoc-plugin-helpers/src/options.test.ts

@@ -1,58 +1,63 @@
 import { describe, expect, it } from "vitest";
-import { parseParams } from "./parseParams";
+import { parseOptions } from "./options";
 
-describe("parseParams", () => {
+describe("parseOptions", () => {
   it("reutrns true if value is empty", () => {
     expect(
-      parseParams("use_protobufjs=true", "nexus").printer.protobuf,
+      parseOptions([{ key: "use_protobufjs", value: "true" }], "nexus").printer
+        .protobuf,
     ).toEqual("protobufjs");
   });
 
   it('parses "true" string to true', () => {
     expect(
-      parseParams("use_protobufjs=true", "nexus").printer.protobuf,
+      parseOptions([{ key: "use_protobufjs", value: "true" }], "nexus").printer
+        .protobuf,
     ).toEqual("protobufjs");
   });
 
   it('parses "true" string to false', () => {
     expect(
-      parseParams("use_protobufjs=false", "nexus").printer.protobuf,
+      parseOptions([{ key: "use_protobufjs", value: "false" }], "nexus").printer
+        .protobuf,
     ).toEqual("google-protobuf");
   });
 
   it("parses importPrefix", () => {
     expect(
-      parseParams("import_prefix=@foobar/baz", "nexus").printer.importPrefix,
+      parseOptions([{ key: "import_prefix", value: "@foobar/baz" }], "nexus")
+        .printer.importPrefix,
     ).toEqual("@foobar/baz");
   });
 
   it("parses fileLayout", () => {
     expect(
-      parseParams("file_layout=graphql_type", "nexus").printer.fileLayout,
+      parseOptions([{ key: "file_layout", value: "graphql_type" }], "nexus")
+        .printer.fileLayout,
     ).toEqual("graphql_type");
   });
 
   it("throws an erorr when useProtobufjs is string", () => {
     expect(() => {
-      parseParams("use_protobufjs=foobar", "nexus");
+      parseOptions([{ key: "use_protobufjs", value: "foobar" }], "nexus");
     }).toThrow();
   });
 
   it("throws an erorr when importString is boolean", () => {
     expect(() => {
-      parseParams("import_prefix", "nexus");
+      parseOptions([{ key: "import_prefix", value: "" }], "nexus");
     }).toThrow();
   });
 
   it("throws an erorr when invalid fileLayout", () => {
     expect(() => {
-      parseParams("file_layout=foobar", "nexus");
+      parseOptions([{ key: "file_layout", value: "foobar" }], "nexus");
     }).toThrow();
   });
 
   it("throws an erorr when received unknown params", () => {
     expect(() => {
-      parseParams("foobar=qux", "nexus");
+      parseOptions([{ key: "foobar", value: "qux" }], "nexus");
     }).toThrow();
   });
 });

…protoc-plugin-helpers/src/parseParams.ts …hql/protoc-plugin-helpers/src/options.tspackages/@proto-graphql/protoc-plugin-helpers/src/parseParams.ts renamed to packages/@proto-graphql/protoc-plugin-helpers/src/options.ts packages/@proto-graphql/protoc-plugin-helpers/src/parseParams.ts renamed to packages/@proto-graphql/protoc-plugin-helpers/src/options.ts

@@ -1,3 +1,4 @@
+import type { RawPluginOptions } from "@bufbuild/protoplugin/dist/cjs/parameter";
 import {
   type PrinterOptions,
   type TypeOptions,
@@ -7,13 +8,27 @@ import {
   protobufLibs,
 } from "@proto-graphql/codegen-core";
 
-export function parseParams<DSL extends PrinterOptions["dsl"]>(
-  input: string | undefined,
-  dsl: DSL,
-): {
+export type Options<DSL extends PrinterOptions["dsl"]> = {
   type: TypeOptions;
   printer: Extract<PrinterOptions, { dsl: DSL }>;
-} {
+};
+
+export function parsePothosOptions(
+  rawOptions: RawPluginOptions,
+): Options<"pothos"> {
+  return parseOptions(rawOptions, "pothos");
+}
+
+export function parseNexusOptions(
+  rawOptions: RawPluginOptions,
+): Options<"nexus"> {
+  return parseOptions(rawOptions, "nexus");
+}
+
+export function parseOptions<DSL extends PrinterOptions["dsl"]>(
+  rawOptions: RawPluginOptions,
+  dsl: DSL,
+): Options<DSL> {
   const params = {
     type: {
       partialInputs: false,
@@ -31,8 +46,8 @@ export function parseParams<DSL extends PrinterOptions["dsl"]>(
     } as Extract<PrinterOptions, { dsl: DSL }>,
   };
 
-  const boolParam = (name: string, v: string | undefined): boolean => {
-    if (!v || v === "true") return true;
+  const boolParam = (name: string, v: string): boolean => {
+    if (v === "" || v === "true") return true;
     if (v === "false") return false;
     throw new Error(`${name} should be bool, got string: ${v}`);
   };
@@ -48,11 +63,7 @@ export function parseParams<DSL extends PrinterOptions["dsl"]>(
     return whitelist.includes(v as any);
   }
 
-  const kvs = input ? input.split(",") : [];
-  for (const kv of kvs) {
-    const idx = kv.indexOf("=");
-    const [k, v] =
-      idx === -1 ? [kv, ""] : [kv.slice(0, idx), kv.slice(idx + 1)];
+  for (const { key: k, value: v } of rawOptions) {
     switch (k) {
       case "use_protobufjs": {
         if (boolParam(k, v)) params.printer.protobuf = "protobufjs";
@@ -114,7 +125,7 @@ export function parseParams<DSL extends PrinterOptions["dsl"]>(
         // no-op
         break;
       default:
-        throw new Error(`unknown param: ${kv}`);
+        throw new Error(`unknown param: ${k}=${v}`);
     }
   }
 

packages/@proto-graphql/protoc-plugin-helpers/src/process.ts

@@ -1,27 +1,21 @@
 import type { DescFile } from "@bufbuild/protobuf";
 import type { Schema } from "@bufbuild/protoplugin";
-import type { PrinterOptions, TypeOptions } from "@proto-graphql/codegen-core";
-
-import { parseParams } from "./parseParams";
+import type { PrinterOptions } from "@proto-graphql/codegen-core";
+import { type Options, parseOptions } from "./options";
 
 export function createTsGenerator<DSL extends PrinterOptions["dsl"]>({
   generateFiles,
   dsl,
 }: {
-  generateFiles: (
-    schema: Schema,
-    file: DescFile,
-    opts: {
-      type: TypeOptions;
-      printer: Extract<PrinterOptions, { dsl: DSL }>;
-    },
-  ) => void;
+  generateFiles: (schema: Schema<Options<DSL>>, file: DescFile) => void;
   dsl: DSL;
-}): (schema: Schema) => void {
-  return function generateTs(schema: Schema) {
-    const params = parseParams(schema.proto.parameter, dsl);
+}): (schema: Schema<Options<DSL>>) => void {
+  return function generateTs(schema: Schema<Partial<Options<DSL>>>) {
+    if (schema.options.printer?.dsl == null) {
+      Object.assign(schema.options, parseOptions([], dsl));
+    }
     for (const file of schema.files) {
-      generateFiles(schema, file, params);
+      generateFiles(schema as Schema<Options<DSL>>, file);
     }
   };
 }

packages/protoc-gen-nexus/src/plugin.ts

@@ -1,5 +1,8 @@
 import { createEcmaScriptPlugin } from "@bufbuild/protoplugin";
-import { createTsGenerator } from "@proto-graphql/protoc-plugin-helpers";
+import {
+  createTsGenerator,
+  parseNexusOptions,
+} from "@proto-graphql/protoc-plugin-helpers";
 
 import { version } from "../package.json";
 import { generateFiles } from "./printer";
@@ -11,9 +14,7 @@ export const protocGenNexus = createEcmaScriptPlugin({
     generateFiles,
     dsl: "nexus",
   }),
-  parseOptions(rawOptions) {
-    return {};
-  },
+  parseOptions: parseNexusOptions,
   // NOTE: force `target=ts`
   transpile: (files) => {
     return files;

packages/protoc-gen-nexus/src/printer.ts

@@ -1,23 +1,23 @@
 import type { DescFile, Registry } from "@bufbuild/protobuf";
 import type { Schema } from "@bufbuild/protoplugin";
 import {
-  type TypeOptions,
   collectTypesFromFile,
   createRegistryFromSchema,
   filename,
   filenameFromProtoFile,
   printCodes,
 } from "@proto-graphql/codegen-core";
+import type { Options } from "@proto-graphql/protoc-plugin-helpers";
 import type { Code } from "ts-poet";
 
 import { createTypeDslCodes } from "./dslgen";
 import type { NexusPrinterOptions } from "./dslgen/printers/util";
 
 export function generateFiles(
-  schema: Schema,
+  schema: Schema<Options<"nexus">>,
   file: DescFile,
-  opts: { type: TypeOptions; printer: NexusPrinterOptions },
 ): void {
+  const opts = schema.options;
   const registry = createRegistryFromSchema(schema);
   const types = collectTypesFromFile(file, opts.type, schema.allFiles);
 

packages/protoc-gen-pothos/src/plugin.ts

@@ -1,5 +1,8 @@
 import { createEcmaScriptPlugin } from "@bufbuild/protoplugin";
-import { createTsGenerator } from "@proto-graphql/protoc-plugin-helpers";
+import {
+  createTsGenerator,
+  parsePothosOptions,
+} from "@proto-graphql/protoc-plugin-helpers";
 
 import { version } from "../package.json";
 import { generateFiles } from "./printer";
@@ -11,9 +14,7 @@ export const protocGenPothos = createEcmaScriptPlugin({
     generateFiles,
     dsl: "pothos",
   }),
-  parseOptions(rawOptions) {
-    return {};
-  },
+  parseOptions: parsePothosOptions,
   // NOTE: force `target=ts`
   transpile: (files) => {
     return files;

packages/protoc-gen-pothos/src/printer.ts

@@ -1,7 +1,6 @@
 import type { DescFile, Registry } from "@bufbuild/protobuf";
 import type { Schema } from "@bufbuild/protoplugin";
 import {
-  type TypeOptions,
   collectTypesFromFile,
   createRegistryFromSchema,
   filename,
@@ -10,16 +9,18 @@ import {
 } from "@proto-graphql/codegen-core";
 import type { Code } from "ts-poet";
 
+import type { Options } from "@proto-graphql/protoc-plugin-helpers";
 import { createTypeDslCodes } from "./dslgen";
 import type { PothosPrinterOptions } from "./dslgen/printers/util";
 
 const allowedProtobufs = ["ts-proto", "protobuf-es"];
 
 export function generateFiles(
-  schema: Schema,
+  schema: Schema<Options<"pothos">>,
   file: DescFile,
-  opts: { type: TypeOptions; printer: PothosPrinterOptions },
 ): void {
+  const opts = schema.options;
+
   if (!allowedProtobufs.includes(opts.printer.protobuf)) {
     opts.printer.protobuf = "ts-proto"; // default
   }