@bufbuild/protoplugin 1.0.0 → 1.1.0

package/dist/cjs/create-es-plugin.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.
@@ -30,8 +30,8 @@ function createEcmaScriptPlugin(init) {
         version: init.version,
         run(req) {
             var _a;
-            const { targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, } = parseParameter(req.parameter, init.parseOption);
-            const { schema, getFileInfo } = (0, schema_js_1.createSchema)(req, targets, init.name, init.version, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles);
+            const { targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, pluginParameter, } = parseParameter(req.parameter, init.parseOption);
+            const { schema, getFileInfo } = (0, schema_js_1.createSchema)(req, targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, init.name, init.version, pluginParameter);
             const targetTs = schema.targets.includes("ts");
             const targetJs = schema.targets.includes("js");
             const targetDts = schema.targets.includes("dts");
@@ -104,7 +104,11 @@ function parseParameter(parameter, parseOption) {
     let keepEmptyFiles = false;
     const rewriteImports = [];
     let importExtension = ".js";
-    for (const { key, value } of splitParameter(parameter)) {
+    const rawParameters = [];
+    for (const { key, value, raw } of splitParameter(parameter)) {
+        // Whether this key/value plugin parameter pair should be
+        // printed to the generated file preamble
+        let printToFile = true;
         switch (key) {
             case "target":
                 targets = [];
@@ -158,6 +162,9 @@ function parseParameter(parameter, parseOption) {
                 }
                 const [pattern, target] = parts;
                 rewriteImports.push({ pattern, target });
+                // rewrite_imports can be noisy and is more of an implementation detail
+                // so we strip it out of the preamble
+                printToFile = false;
                 break;
             }
             case "import_extension": {
@@ -191,7 +198,11 @@ function parseParameter(parameter, parseOption) {
                 }
                 break;
         }
+        if (printToFile) {
+            rawParameters.push(raw);
+        }
     }
+    const pluginParameter = rawParameters.join(",");
     return {
         targets,
         tsNocheck,
@@ -199,17 +210,19 @@ function parseParameter(parameter, parseOption) {
         rewriteImports,
         importExtension,
         keepEmptyFiles,
+        pluginParameter,
     };
 }
 function splitParameter(parameter) {
     if (parameter == undefined) {
         return [];
     }
-    return parameter.split(",").map((pair) => {
-        const i = pair.indexOf("=");
+    return parameter.split(",").map((raw) => {
+        const i = raw.indexOf("=");
         return {
-            key: i === -1 ? pair : pair.substring(0, i),
-            value: i === -1 ? "" : pair.substring(i + 1),
+            key: i === -1 ? raw : raw.substring(0, i),
+            value: i === -1 ? "" : raw.substring(i + 1),
+            raw,
         };
     });
 }

package/dist/cjs/ecmascript/custom-options.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/cjs/ecmascript/gencommon.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.
@@ -37,7 +37,7 @@ function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck)
     };
     writeLeadingComments(file.getSyntaxComments());
     builder.push(`// @generated by ${pluginName} ${pluginVersion}`);
-    if (parameter !== undefined) {
+    if (parameter !== "") {
         builder.push(` with parameter "${parameter}"`);
     }
     builder.push("\n");

package/dist/cjs/ecmascript/generated-file.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.
@@ -22,7 +22,7 @@ function createGeneratedFile(name, importPath, rewriteImportPath, createTypeImpo
     const el = [];
     return {
         preamble(file) {
-            preamble = (0, gencommon_js_1.makeFilePreamble)(file, preambleSettings.pluginName, preambleSettings.pluginVersion, preambleSettings.parameter, preambleSettings.tsNocheck);
+            preamble = (0, gencommon_js_1.makeFilePreamble)(file, preambleSettings.pluginName, preambleSettings.pluginVersion, preambleSettings.pluginParameter, preambleSettings.tsNocheck);
         },
         print(printableOrFragments, ...rest) {
             let printables;

package/dist/cjs/ecmascript/import-path.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/cjs/ecmascript/import-symbol.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/cjs/ecmascript/index.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/cjs/ecmascript/runtime-imports.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/cjs/ecmascript/schema.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.
@@ -19,7 +19,7 @@ const generated_file_js_1 = require("./generated-file.js");
 const runtime_imports_js_1 = require("./runtime-imports.js");
 const import_symbol_js_1 = require("./import-symbol.js");
 const import_path_js_1 = require("./import-path.js");
-function createSchema(request, targets, pluginName, pluginVersion, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles) {
+function createSchema(request, targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, pluginName, pluginVersion, pluginParameter) {
     const descriptorSet = (0, protobuf_1.createDescriptorSet)(request.protoFile);
     const filesToGenerate = findFilesToGenerate(descriptorSet, request);
     const runtime = (0, runtime_imports_js_1.createRuntimeImports)(bootstrapWkt);
@@ -39,7 +39,7 @@ function createSchema(request, targets, pluginName, pluginVersion, tsNocheck, bo
             const genFile = (0, generated_file_js_1.createGeneratedFile)(name, (0, import_path_js_1.deriveImportPath)(name), (importPath) => (0, import_path_js_1.rewriteImportPath)(importPath, rewriteImports, importExtension), createTypeImport, runtime, {
                 pluginName,
                 pluginVersion,
-                parameter: request.parameter,
+                pluginParameter,
                 tsNocheck,
             }, keepEmptyFiles);
             generatedFiles.push(genFile);

package/dist/cjs/ecmascript/target.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/cjs/ecmascript/transpile.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/cjs/error.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/cjs/index.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/cjs/plugin.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/cjs/run-node.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/esm/create-es-plugin.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.
@@ -27,8 +27,8 @@ export function createEcmaScriptPlugin(init) {
         version: init.version,
         run(req) {
             var _a;
-            const { targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, } = parseParameter(req.parameter, init.parseOption);
-            const { schema, getFileInfo } = createSchema(req, targets, init.name, init.version, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles);
+            const { targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, pluginParameter, } = parseParameter(req.parameter, init.parseOption);
+            const { schema, getFileInfo } = createSchema(req, targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, init.name, init.version, pluginParameter);
             const targetTs = schema.targets.includes("ts");
             const targetJs = schema.targets.includes("js");
             const targetDts = schema.targets.includes("dts");
@@ -100,7 +100,11 @@ function parseParameter(parameter, parseOption) {
     let keepEmptyFiles = false;
     const rewriteImports = [];
     let importExtension = ".js";
-    for (const { key, value } of splitParameter(parameter)) {
+    const rawParameters = [];
+    for (const { key, value, raw } of splitParameter(parameter)) {
+        // Whether this key/value plugin parameter pair should be
+        // printed to the generated file preamble
+        let printToFile = true;
         switch (key) {
             case "target":
                 targets = [];
@@ -154,6 +158,9 @@ function parseParameter(parameter, parseOption) {
                 }
                 const [pattern, target] = parts;
                 rewriteImports.push({ pattern, target });
+                // rewrite_imports can be noisy and is more of an implementation detail
+                // so we strip it out of the preamble
+                printToFile = false;
                 break;
             }
             case "import_extension": {
@@ -187,7 +194,11 @@ function parseParameter(parameter, parseOption) {
                 }
                 break;
         }
+        if (printToFile) {
+            rawParameters.push(raw);
+        }
     }
+    const pluginParameter = rawParameters.join(",");
     return {
         targets,
         tsNocheck,
@@ -195,17 +206,19 @@ function parseParameter(parameter, parseOption) {
         rewriteImports,
         importExtension,
         keepEmptyFiles,
+        pluginParameter,
     };
 }
 function splitParameter(parameter) {
     if (parameter == undefined) {
         return [];
     }
-    return parameter.split(",").map((pair) => {
-        const i = pair.indexOf("=");
+    return parameter.split(",").map((raw) => {
+        const i = raw.indexOf("=");
         return {
-            key: i === -1 ? pair : pair.substring(0, i),
-            value: i === -1 ? "" : pair.substring(i + 1),
+            key: i === -1 ? raw : raw.substring(0, i),
+            value: i === -1 ? "" : raw.substring(i + 1),
+            raw,
         };
     });
 }

package/dist/esm/ecmascript/custom-options.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/esm/ecmascript/gencommon.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.
@@ -34,7 +34,7 @@ export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsN
     };
     writeLeadingComments(file.getSyntaxComments());
     builder.push(`// @generated by ${pluginName} ${pluginVersion}`);
-    if (parameter !== undefined) {
+    if (parameter !== "") {
         builder.push(` with parameter "${parameter}"`);
     }
     builder.push("\n");

package/dist/esm/ecmascript/generated-file.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.
@@ -19,7 +19,7 @@ export function createGeneratedFile(name, importPath, rewriteImportPath, createT
     const el = [];
     return {
         preamble(file) {
-            preamble = makeFilePreamble(file, preambleSettings.pluginName, preambleSettings.pluginVersion, preambleSettings.parameter, preambleSettings.tsNocheck);
+            preamble = makeFilePreamble(file, preambleSettings.pluginName, preambleSettings.pluginVersion, preambleSettings.pluginParameter, preambleSettings.tsNocheck);
         },
         print(printableOrFragments, ...rest) {
             let printables;

package/dist/esm/ecmascript/import-path.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/esm/ecmascript/import-symbol.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/esm/ecmascript/index.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/esm/ecmascript/runtime-imports.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/esm/ecmascript/schema.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.
@@ -16,7 +16,7 @@ import { createGeneratedFile } from "./generated-file.js";
 import { createRuntimeImports } from "./runtime-imports.js";
 import { createImportSymbol } from "./import-symbol.js";
 import { deriveImportPath, makeImportPath, rewriteImportPath, } from "./import-path.js";
-export function createSchema(request, targets, pluginName, pluginVersion, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles) {
+export function createSchema(request, targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, pluginName, pluginVersion, pluginParameter) {
     const descriptorSet = createDescriptorSet(request.protoFile);
     const filesToGenerate = findFilesToGenerate(descriptorSet, request);
     const runtime = createRuntimeImports(bootstrapWkt);
@@ -36,7 +36,7 @@ export function createSchema(request, targets, pluginName, pluginVersion, tsNoch
             const genFile = createGeneratedFile(name, deriveImportPath(name), (importPath) => rewriteImportPath(importPath, rewriteImports, importExtension), createTypeImport, runtime, {
                 pluginName,
                 pluginVersion,
-                parameter: request.parameter,
+                pluginParameter,
                 tsNocheck,
             }, keepEmptyFiles);
             generatedFiles.push(genFile);

package/dist/esm/ecmascript/target.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/esm/ecmascript/transpile.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/esm/error.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/esm/index.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/esm/plugin.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/esm/run-node.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2022 Buf Technologies, Inc.
+// Copyright 2021-2023 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.

package/dist/types/ecmascript/gencommon.d.ts

@@ -1,7 +1,7 @@
 import { DescEnum, DescEnumValue, DescField, DescFile, DescMessage, DescMethod, DescOneof, DescService, ScalarType } from "@bufbuild/protobuf";
 import type { GeneratedFile, Printable } from "./generated-file.js";
 import type { ImportSymbol } from "./import-symbol.js";
-export declare function makeFilePreamble(file: DescFile, pluginName: string, pluginVersion: string, parameter: string | undefined, tsNoCheck: boolean): string;
+export declare function makeFilePreamble(file: DescFile, pluginName: string, pluginVersion: string, parameter: string, tsNoCheck: boolean): string;
 export declare function createJsDocBlock(text: string, indentation?: string): Printable;
 export declare function makeJsDoc(desc: DescEnum | DescEnumValue | DescMessage | DescOneof | DescField | DescService | DescMethod, indentation?: string): Printable;
 /**

package/dist/types/ecmascript/generated-file.d.ts

@@ -71,7 +71,7 @@ type RewriteImportPathFn = (path: string) => string;
 export declare function createGeneratedFile(name: string, importPath: string, rewriteImportPath: RewriteImportPathFn, createTypeImport: CreateTypeImportFn, runtimeImports: RuntimeImports, preambleSettings: {
     pluginName: string;
     pluginVersion: string;
-    parameter: string | undefined;
+    pluginParameter: string;
     tsNocheck: boolean;
 }, keepEmpty: boolean): GeneratedFile & GenerateFileToFileInfo;
 export {};

package/dist/types/ecmascript/schema.d.ts

@@ -38,6 +38,6 @@ interface SchemaController {
     schema: Schema;
     getFileInfo: () => FileInfo[];
 }
-export declare function createSchema(request: CodeGeneratorRequest, targets: Target[], pluginName: string, pluginVersion: string, tsNocheck: boolean, bootstrapWkt: boolean, rewriteImports: RewriteImports, importExtension: string, keepEmptyFiles: boolean): SchemaController;
+export declare function createSchema(request: CodeGeneratorRequest, targets: Target[], tsNocheck: boolean, bootstrapWkt: boolean, rewriteImports: RewriteImports, importExtension: string, keepEmptyFiles: boolean, pluginName: string, pluginVersion: string, pluginParameter: string): SchemaController;
 export declare function toResponse(files: FileInfo[]): CodeGeneratorResponse;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoplugin",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "license": "(Apache-2.0 AND BSD-3-Clause)",
   "description": "Helps to create your own Protocol Buffers code generators.",
   "repository": {
@@ -35,7 +35,7 @@
     }
   },
   "dependencies": {
-    "@bufbuild/protobuf": "1.0.0",
+    "@bufbuild/protobuf": "1.1.0",
     "@typescript/vfs": "^1.4.0",
     "typescript": "4.5.2"
   },