@bufbuild/protoplugin 2.2.5 → 2.4.0

package/dist/cjs/create-es-plugin.d.ts

@@ -2,7 +2,6 @@ import { type SupportedEdition } from "@bufbuild/protobuf";
 import type { Schema } from "./schema.js";
 import type { FileInfo } from "./generated-file.js";
 import type { Plugin } from "./plugin.js";
-import type { RawPluginOptions } from "./parameter.js";
 interface PluginInit<Options extends object> {
     /**
      * Name of this code generator plugin.
@@ -15,8 +14,26 @@ interface PluginInit<Options extends object> {
     /**
      * An optional parsing function which can be used to parse your own plugin
      * options.
+     *
+     * For example, if a plugin is run with the options foo=123,bar,baz=a,baz=b
+     * the raw options are:
+     *
+     * ```ts
+     * [
+     *   { key: "foo", value: "123" },
+     *   { key: "bar", value: "" },
+     *   { key: "baz", value: "a" },
+     *   { key: "baz", value: "b" },
+     * ]
+     * ```
+     *
+     * If your plugin does not recognize an option, it must throw an Error in
+     * parseOptions.
      */
-    parseOptions?: (rawOptions: RawPluginOptions) => Options;
+    parseOptions?: (rawOptions: {
+        key: string;
+        value: string;
+    }[]) => Options;
     /**
      * The earliest edition supported by this plugin. Defaults to the minimum
      * edition supported by @bufbuild/protobuf.

package/dist/cjs/file-preamble.js

@@ -47,10 +47,10 @@ function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck)
     }
     switch (file.edition) {
         case wkt_1.Edition.EDITION_PROTO2:
-            builder.push(`syntax proto2)\n`);
+            builder.push("syntax proto2)\n");
             break;
         case wkt_1.Edition.EDITION_PROTO3:
-            builder.push(`syntax proto3)\n`);
+            builder.push("syntax proto3)\n");
             break;
         default: {
             const editionString = wkt_1.Edition[file.edition];
@@ -59,7 +59,7 @@ function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck)
                 builder.push(`edition ${e})\n`);
             }
             else {
-                builder.push(`unknown edition\n`);
+                builder.push("unknown edition\n");
             }
             break;
         }

package/dist/cjs/generated-file.js

@@ -113,7 +113,7 @@ function elToContent(el, importerPath, rewriteImportPath, legacyCommonJs) {
     if (legacyCommonJs) {
         c.push(`"use strict";\n`);
         c.push(`Object.defineProperty(exports, "__esModule", { value: true });\n`);
-        c.push(`\n`);
+        c.push("\n");
     }
     const symbolToIdentifier = processImports(el, importerPath, rewriteImportPath, (typeOnly, from, names) => {
         if (legacyCommonJs) {
@@ -166,10 +166,10 @@ function elToContent(el, importerPath, rewriteImportPath, legacyCommonJs) {
     }
     if (legacyCommonJs) {
         if (legacyCommonJsExportNames.length > 0) {
-            c.push(`\n`);
+            c.push("\n");
         }
         for (const name of legacyCommonJsExportNames) {
-            c.push(`exports.`, name, " = ", name, ";\n");
+            c.push("exports.", name, " = ", name, ";\n");
         }
     }
     return c.join("");

package/dist/cjs/names.js

@@ -77,35 +77,35 @@ function generatedJsonTypeName(desc) {
  * Compute the ideal name for a generated descriptor.
  */
 function idealDescName(desc, i) {
-    const escape = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
+    const salt = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
     if (desc.kind == "file") {
         const name = "file_" + desc.name.replace(/[^a-zA-Z0-9_]+/g, "_");
-        return (0, safe_identifier_js_1.safeIdentifier)(name + escape);
+        return (0, safe_identifier_js_1.safeIdentifier)(name + salt);
     }
     switch (desc.kind) {
         case "enum":
-            return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + "Schema" + escape);
+            return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + "Schema" + salt);
         case "message":
-            return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + "Schema" + escape);
+            return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + "Schema" + salt);
         case "extension":
-            return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + escape);
+            return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + salt);
         case "service":
-            return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + escape);
+            return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + salt);
     }
 }
 /**
  * Compute the ideal name for a generated shape.
  */
 function idealShapeName(desc, i) {
-    const escape = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
-    return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + escape);
+    const salt = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
+    return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + salt);
 }
 /**
  * Compute the ideal name for a generated JSON type.
  */
 function idealJsonTypeName(desc, i) {
-    const escape = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
-    return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + "Json" + escape);
+    const salt = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
+    return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + "Json" + salt);
 }
 /**
  * Return an identifier for the given descriptor based on its type name.

package/dist/cjs/parameter.d.ts

@@ -56,26 +56,7 @@ export interface ParsedParameter<T> {
     parsed: T & EcmaScriptPluginOptions;
     sanitized: string;
 }
-/**
- * Raw options to parse.
- *
- * For example, if a plugin is run with the options foo=123,bar,baz=a,baz=b
- * the raw options are:
- *
- * ```ts
- * [
- *   { key: "foo", value: "123" },
- *   { key: "bar", value: "" },
- *   { key: "baz", value: "a" },
- *   { key: "baz", value: "b" },
- * ]
- * ```
- *
- * If your plugin does not recognize an option, it must throw an Error in
- * parseOptions.
- */
-export type RawPluginOptions = {
+export declare function parseParameter<T extends object>(parameter: string, parseExtraOptions: ((rawOptions: {
     key: string;
     value: string;
-}[];
-export declare function parseParameter<T extends object>(parameter: string, parseExtraOptions: ((rawOptions: RawPluginOptions) => T) | undefined): ParsedParameter<T>;
+}[]) => T) | undefined): ParsedParameter<T>;

package/dist/cjs/parameter.js

@@ -158,7 +158,7 @@ function parseParameter(parameter, parseExtraOptions) {
         jsImportStyle,
         keepEmptyFiles,
     };
-    if (parseExtraOptions === undefined || extraParameters.length === 0) {
+    if (parseExtraOptions === undefined) {
         return {
             parsed: ecmaScriptPluginOptions,
             sanitized: sanitizedParameters,

package/dist/cjs/source-code-info.js

@@ -217,7 +217,7 @@ function getDeclarationString(desc) {
     }
     if (protoOptions !== undefined &&
         (0, protobuf_1.isFieldSet)(protoOptions, wkt_1.FieldOptionsSchema.field.deprecated)) {
-        options.push(`deprecated = true`);
+        options.push("deprecated = true");
     }
     options.push(...getFeatureOptionStrings(desc));
     if (options.length > 0) {

package/dist/cjs/transpile.js

@@ -19,7 +19,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.transpile = transpile;
 const typescript_1 = __importDefault(require("typescript"));
 const vfs_1 = require("@typescript/vfs");
-/* eslint-disable import/no-named-as-default-member */
 // The default options used to auto-transpile if needed.
 const defaultOptions = {
     // Type checking
@@ -71,9 +70,9 @@ function createTranspiler(options, files) {
     const fsMap = (0, vfs_1.createDefaultMapFromNodeModules)({
         target: options.target,
     });
-    files.forEach((file) => {
+    for (const file of files) {
         fsMap.set(file.name, file.content);
-    });
+    }
     const system = (0, vfs_1.createSystem)(fsMap);
     const host = (0, vfs_1.createVirtualCompilerHost)(system, options, typescript_1.default);
     return typescript_1.default.createProgram({
@@ -91,7 +90,7 @@ function transpile(files, transpileJs, transpileDts, jsImportStyle) {
     const program = createTranspiler(options, files);
     const results = [];
     let err;
-    const result = program.emit(undefined, (fileName, data, writeByteOrderMark, onError, sourceFiles) => {
+    const result = program.emit(undefined, (fileName, data, _writeByteOrderMark, _onError, sourceFiles) => {
         // We have to go through some hoops here because the header we add to each
         // file is not part of the AST. So we find the TypeScript file we
         // generated for each emitted file and add the header to each output ourselves.

package/dist/esm/create-es-plugin.d.ts

@@ -2,7 +2,6 @@ import { type SupportedEdition } from "@bufbuild/protobuf";
 import type { Schema } from "./schema.js";
 import type { FileInfo } from "./generated-file.js";
 import type { Plugin } from "./plugin.js";
-import type { RawPluginOptions } from "./parameter.js";
 interface PluginInit<Options extends object> {
     /**
      * Name of this code generator plugin.
@@ -15,8 +14,26 @@ interface PluginInit<Options extends object> {
     /**
      * An optional parsing function which can be used to parse your own plugin
      * options.
+     *
+     * For example, if a plugin is run with the options foo=123,bar,baz=a,baz=b
+     * the raw options are:
+     *
+     * ```ts
+     * [
+     *   { key: "foo", value: "123" },
+     *   { key: "bar", value: "" },
+     *   { key: "baz", value: "a" },
+     *   { key: "baz", value: "b" },
+     * ]
+     * ```
+     *
+     * If your plugin does not recognize an option, it must throw an Error in
+     * parseOptions.
      */
-    parseOptions?: (rawOptions: RawPluginOptions) => Options;
+    parseOptions?: (rawOptions: {
+        key: string;
+        value: string;
+    }[]) => Options;
     /**
      * The earliest edition supported by this plugin. Defaults to the minimum
      * edition supported by @bufbuild/protobuf.

package/dist/esm/file-preamble.js

@@ -44,10 +44,10 @@ export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsN
     }
     switch (file.edition) {
         case Edition.EDITION_PROTO2:
-            builder.push(`syntax proto2)\n`);
+            builder.push("syntax proto2)\n");
             break;
         case Edition.EDITION_PROTO3:
-            builder.push(`syntax proto3)\n`);
+            builder.push("syntax proto3)\n");
             break;
         default: {
             const editionString = Edition[file.edition];
@@ -56,7 +56,7 @@ export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsN
                 builder.push(`edition ${e})\n`);
             }
             else {
-                builder.push(`unknown edition\n`);
+                builder.push("unknown edition\n");
             }
             break;
         }

package/dist/esm/generated-file.js

@@ -110,7 +110,7 @@ function elToContent(el, importerPath, rewriteImportPath, legacyCommonJs) {
     if (legacyCommonJs) {
         c.push(`"use strict";\n`);
         c.push(`Object.defineProperty(exports, "__esModule", { value: true });\n`);
-        c.push(`\n`);
+        c.push("\n");
     }
     const symbolToIdentifier = processImports(el, importerPath, rewriteImportPath, (typeOnly, from, names) => {
         if (legacyCommonJs) {
@@ -163,10 +163,10 @@ function elToContent(el, importerPath, rewriteImportPath, legacyCommonJs) {
     }
     if (legacyCommonJs) {
         if (legacyCommonJsExportNames.length > 0) {
-            c.push(`\n`);
+            c.push("\n");
         }
         for (const name of legacyCommonJsExportNames) {
-            c.push(`exports.`, name, " = ", name, ";\n");
+            c.push("exports.", name, " = ", name, ";\n");
         }
     }
     return c.join("");

package/dist/esm/names.js

@@ -71,35 +71,35 @@ export function generatedJsonTypeName(desc) {
  * Compute the ideal name for a generated descriptor.
  */
 function idealDescName(desc, i) {
-    const escape = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
+    const salt = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
     if (desc.kind == "file") {
         const name = "file_" + desc.name.replace(/[^a-zA-Z0-9_]+/g, "_");
-        return safeIdentifier(name + escape);
+        return safeIdentifier(name + salt);
     }
     switch (desc.kind) {
         case "enum":
-            return safeIdentifier(identifier(desc) + "Schema" + escape);
+            return safeIdentifier(identifier(desc) + "Schema" + salt);
         case "message":
-            return safeIdentifier(identifier(desc) + "Schema" + escape);
+            return safeIdentifier(identifier(desc) + "Schema" + salt);
         case "extension":
-            return safeIdentifier(identifier(desc) + escape);
+            return safeIdentifier(identifier(desc) + salt);
         case "service":
-            return safeIdentifier(identifier(desc) + escape);
+            return safeIdentifier(identifier(desc) + salt);
     }
 }
 /**
  * Compute the ideal name for a generated shape.
  */
 function idealShapeName(desc, i) {
-    const escape = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
-    return safeIdentifier(identifier(desc) + escape);
+    const salt = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
+    return safeIdentifier(identifier(desc) + salt);
 }
 /**
  * Compute the ideal name for a generated JSON type.
  */
 function idealJsonTypeName(desc, i) {
-    const escape = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
-    return safeIdentifier(identifier(desc) + "Json" + escape);
+    const salt = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
+    return safeIdentifier(identifier(desc) + "Json" + salt);
 }
 /**
  * Return an identifier for the given descriptor based on its type name.

package/dist/esm/parameter.d.ts

@@ -56,26 +56,7 @@ export interface ParsedParameter<T> {
     parsed: T & EcmaScriptPluginOptions;
     sanitized: string;
 }
-/**
- * Raw options to parse.
- *
- * For example, if a plugin is run with the options foo=123,bar,baz=a,baz=b
- * the raw options are:
- *
- * ```ts
- * [
- *   { key: "foo", value: "123" },
- *   { key: "bar", value: "" },
- *   { key: "baz", value: "a" },
- *   { key: "baz", value: "b" },
- * ]
- * ```
- *
- * If your plugin does not recognize an option, it must throw an Error in
- * parseOptions.
- */
-export type RawPluginOptions = {
+export declare function parseParameter<T extends object>(parameter: string, parseExtraOptions: ((rawOptions: {
     key: string;
     value: string;
-}[];
-export declare function parseParameter<T extends object>(parameter: string, parseExtraOptions: ((rawOptions: RawPluginOptions) => T) | undefined): ParsedParameter<T>;
+}[]) => T) | undefined): ParsedParameter<T>;

package/dist/esm/parameter.js

@@ -155,7 +155,7 @@ export function parseParameter(parameter, parseExtraOptions) {
         jsImportStyle,
         keepEmptyFiles,
     };
-    if (parseExtraOptions === undefined || extraParameters.length === 0) {
+    if (parseExtraOptions === undefined) {
         return {
             parsed: ecmaScriptPluginOptions,
             sanitized: sanitizedParameters,

package/dist/esm/source-code-info.js

@@ -210,7 +210,7 @@ export function getDeclarationString(desc) {
     }
     if (protoOptions !== undefined &&
         isFieldSet(protoOptions, FieldOptionsSchema.field.deprecated)) {
-        options.push(`deprecated = true`);
+        options.push("deprecated = true");
     }
     options.push(...getFeatureOptionStrings(desc));
     if (options.length > 0) {

package/dist/esm/transpile.js

@@ -13,7 +13,6 @@
 // limitations under the License.
 import ts from "typescript";
 import { createDefaultMapFromNodeModules, createSystem, createVirtualCompilerHost, } from "@typescript/vfs";
-/* eslint-disable import/no-named-as-default-member */
 // The default options used to auto-transpile if needed.
 const defaultOptions = {
     // Type checking
@@ -65,9 +64,9 @@ function createTranspiler(options, files) {
     const fsMap = createDefaultMapFromNodeModules({
         target: options.target,
     });
-    files.forEach((file) => {
+    for (const file of files) {
         fsMap.set(file.name, file.content);
-    });
+    }
     const system = createSystem(fsMap);
     const host = createVirtualCompilerHost(system, options, ts);
     return ts.createProgram({
@@ -85,7 +84,7 @@ export function transpile(files, transpileJs, transpileDts, jsImportStyle) {
     const program = createTranspiler(options, files);
     const results = [];
     let err;
-    const result = program.emit(undefined, (fileName, data, writeByteOrderMark, onError, sourceFiles) => {
+    const result = program.emit(undefined, (fileName, data, _writeByteOrderMark, _onError, sourceFiles) => {
         // We have to go through some hoops here because the header we add to each
         // file is not part of the AST. So we find the TypeScript file we
         // generated for each emitted file and add the header to each output ourselves.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoplugin",
-  "version": "2.2.5",
+  "version": "2.4.0",
   "license": "Apache-2.0",
   "description": "Helps to create your own Protocol Buffers code generators.",
   "keywords": [
@@ -20,9 +20,9 @@
     "build": "npm run build:cjs && npm run build:esm",
     "build:cjs": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module commonjs --verbatimModuleSyntax false --moduleResolution node10 --outDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
     "build:esm": "../../node_modules/typescript/bin/tsc --project tsconfig.json --outDir ./dist/esm",
-    "format": "prettier --write --ignore-unknown '.' '!dist' '!.turbo'",
+    "format": "biome format --write",
     "license-header": "license-header",
-    "lint": "eslint --max-warnings 0 .",
+    "lint": "biome lint --error-on-warnings",
     "attw": "attw --pack"
   },
   "type": "module",
@@ -35,13 +35,11 @@
     }
   },
   "dependencies": {
-    "@bufbuild/protobuf": "2.2.5",
+    "@bufbuild/protobuf": "2.4.0",
     "@typescript/vfs": "^1.5.2",
     "typescript": "5.4.5"
   },
-  "files": [
-    "dist/**"
-  ],
+  "files": ["dist/**"],
   "devDependencies": {
     "@types/lz-string": "^1.5.0"
   }