@bufbuild/protoplugin 2.0.0-beta.2 → 2.0.0-beta.3

package/README.md

@@ -1,13 +1,14 @@
 # @bufbuild/protoplugin
 
-This package helps to create your own code generator plugin using the
+This package helps you create your own code generator plugin using the
 Protobuf-ES plugin framework.
 
-**Protobuf-ES** is a complete implementation of [Protocol Buffers](https://developers.google.com/protocol-buffers) in TypeScript, suitable for web browsers and Node.js.
+**Protobuf-ES** is a complete implementation of [Protocol Buffers](https://protobuf.dev) in TypeScript, suitable for
+web browsers and Node.js.
 
-In addition to a full Protobuf runtime library, it also provides a code generator
-[`protoc-gen-es`](https://www.npmjs.com/package/@bufbuild/protoc-gen-es), which utilizes a plugin framework to generate base types from
-your Protobuf schema. It is fully compatible with both Buf and protoc compilers.
+In addition to a full Protobuf runtime library, it provides the [`protoc-gen-es`](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
+code generator, which uses a plugin framework to generate base types from
+your Protobuf schema. It is fully compatible with both `buf` and `protoc` compilers.
 
 And now, you can write your own **Protobuf-ES** compatible plugins using this same
 plugin framework with the `@bufbuild/protoplugin` package.
@@ -31,4 +32,4 @@ ECMAScript-compliant code.
 
 ## Usage
 
-Get started now with our [plugin documentation](https://github.com/bufbuild/protobuf-es/blob/main/docs/writing_plugins.md).
+Get started now with our [plugin documentation](https://github.com/bufbuild/protobuf-es/blob/main/MANUAL.md#writing-plugins).

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

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createEcmaScriptPlugin = void 0;
+exports.createEcmaScriptPlugin = createEcmaScriptPlugin;
 const protobuf_1 = require("@bufbuild/protobuf");
 const protobuf_2 = require("@bufbuild/protobuf");
 const wkt_1 = require("@bufbuild/protobuf/wkt");
@@ -104,7 +104,6 @@ function createEcmaScriptPlugin(init) {
         },
     };
 }
-exports.createEcmaScriptPlugin = createEcmaScriptPlugin;
 function toResponse(files, minimumEdition, maximumEdition) {
     return (0, protobuf_1.create)(wkt_1.CodeGeneratorResponseSchema, {
         supportedFeatures: protobuf_1.protoInt64.parse(wkt_1.CodeGeneratorResponse_Feature.PROTO3_OPTIONAL |

package/dist/cjs/error.js

@@ -13,7 +13,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isPluginOptionError = exports.reasonToString = exports.PluginOptionError = void 0;
+exports.PluginOptionError = void 0;
+exports.reasonToString = reasonToString;
+exports.isPluginOptionError = isPluginOptionError;
 class PluginOptionError extends Error {
     constructor(option, reason) {
         const detail = reason !== undefined ? reasonToString(reason) : "";
@@ -33,11 +35,9 @@ function reasonToString(reason) {
     }
     return String(reason);
 }
-exports.reasonToString = reasonToString;
 function isPluginOptionError(arg) {
     if (!(arg instanceof Error)) {
         return false;
     }
     return arg.name === "PluginOptionError";
 }
-exports.isPluginOptionError = isPluginOptionError;

package/dist/cjs/file-preamble.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeFilePreamble = void 0;
+exports.makeFilePreamble = makeFilePreamble;
 const wkt_1 = require("@bufbuild/protobuf/wkt");
 const source_code_info_js_1 = require("./source-code-info.js");
 function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck) {
@@ -75,4 +75,3 @@ function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck)
     writeLeadingComments((0, source_code_info_js_1.getPackageComments)(file));
     return trimSuffix(builder.join(""), "\n");
 }
-exports.makeFilePreamble = makeFilePreamble;

package/dist/cjs/generated-file.d.ts

@@ -48,6 +48,10 @@ export interface GeneratedFile {
      * Create a string literal.
      */
     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.

package/dist/cjs/generated-file.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createGeneratedFile = void 0;
+exports.createGeneratedFile = createGeneratedFile;
 const protobuf_1 = require("@bufbuild/protobuf");
 const import_symbol_js_1 = require("./import-symbol.js");
 const import_path_js_1 = require("./import-path.js");
@@ -61,6 +61,18 @@ function createGeneratedFile(name, importPath, jsImportStyle, rewriteImport, res
                 value: string,
             };
         },
+        array(elements) {
+            const p = [];
+            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",
@@ -93,7 +105,6 @@ function createGeneratedFile(name, importPath, jsImportStyle, rewriteImport, res
         },
     };
 }
-exports.createGeneratedFile = createGeneratedFile;
 function elToContent(el, importerPath, rewriteImportPath, legacyCommonJs) {
     if (el.length == 0) {
         return "";

package/dist/cjs/import-path.d.ts

@@ -1,3 +1,4 @@
+import type { ImportExtension } from "./parameter.js";
 /**
  * A configuration for rewriting import paths, a feature mainly used for
  * remote code generation in the BSR npm registry, which makes it possible
@@ -42,7 +43,7 @@ export type RewriteImports = {
  * Apply import rewrites to the given import path, and change all .js extensions
  * to the given import extension.
  */
-export declare function rewriteImportPath(importPath: string, rewriteImports: RewriteImports, importExtension: string): string;
+export declare function rewriteImportPath(importPath: string, rewriteImports: RewriteImports, importExtension: ImportExtension): string;
 export declare const relativePathRE: RegExp;
 /**
  * Derives an ECMAScript module import path from a file path. For example,

package/dist/cjs/import-path.js

@@ -13,7 +13,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeImportPathRelative = exports.deriveImportPath = exports.relativePathRE = exports.rewriteImportPath = void 0;
+exports.relativePathRE = void 0;
+exports.rewriteImportPath = rewriteImportPath;
+exports.deriveImportPath = deriveImportPath;
+exports.makeImportPathRelative = makeImportPathRelative;
 const cache = new WeakMap();
 /**
  * Apply import rewrites to the given import path, and change all .js extensions
@@ -42,13 +45,17 @@ function rewriteImportPath(importPath, rewriteImports, importExtension) {
             break;
         }
     }
-    if (importExtension != ".js" && importPath.endsWith(".js")) {
-        importPath =
-            importPath.substring(0, importPath.length - 3) + importExtension;
+    if (importPath.endsWith(".js")) {
+        switch (importExtension) {
+            case "none":
+                return importPath.substring(0, importPath.length - 3);
+            case "ts":
+            case "js":
+                return importPath.substring(0, importPath.length - 2) + importExtension;
+        }
     }
     return importPath;
 }
-exports.rewriteImportPath = rewriteImportPath;
 function starToRegExp(star) {
     const r = ["^"];
     for (let i = 0; i < star.length; i++) {
@@ -96,7 +103,6 @@ function deriveImportPath(filename) {
     }
     return importPath;
 }
-exports.deriveImportPath = deriveImportPath;
 /**
  * Makes an import path relative to the file importing it. For example,
  * consider the following files:
@@ -132,4 +138,3 @@ function makeImportPathRelative(importer, importPath) {
         .join("/");
     return exports.relativePathRE.test(c) ? c : "./" + c;
 }
-exports.makeImportPathRelative = makeImportPathRelative;

package/dist/cjs/import-symbol.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createImportSymbol = void 0;
+exports.createImportSymbol = createImportSymbol;
 /**
  * Create a new import symbol.
  */
@@ -29,4 +29,3 @@ function createImportSymbol(name, from, typeOnly) {
         },
     };
 }
-exports.createImportSymbol = createImportSymbol;

package/dist/cjs/index.d.ts

@@ -2,9 +2,8 @@ export type { Plugin } from "./plugin.js";
 export { runNodeJs } from "./run-node.js";
 export { createEcmaScriptPlugin } from "./create-es-plugin.js";
 export { getComments, getDeclarationString, getPackageComments, getSyntaxComments, } from "./source-code-info.js";
-export type { Target } from "./target.js";
 export type { Schema } from "./schema.js";
-export type { EcmaScriptPluginOptions } from "./parameter.js";
+export type { EcmaScriptPluginOptions, Target, ImportExtension, } from "./parameter.js";
 export type { GeneratedFile, FileInfo } from "./generated-file.js";
 export type { ImportSymbol } from "./import-symbol.js";
 export { createImportSymbol } from "./import-symbol.js";

package/dist/cjs/jsdoc.js

@@ -13,7 +13,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatJsDocBlock = exports.createJsDocTextFromDesc = void 0;
+exports.createJsDocTextFromDesc = createJsDocTextFromDesc;
+exports.formatJsDocBlock = formatJsDocBlock;
 const source_code_info_js_1 = require("./source-code-info.js");
 const reflect_1 = require("@bufbuild/protobuf/reflect");
 function createJsDocTextFromDesc(desc) {
@@ -81,7 +82,6 @@ function createJsDocTextFromDesc(desc) {
     }
     return text;
 }
-exports.createJsDocTextFromDesc = createJsDocTextFromDesc;
 function formatJsDocBlock(text, indentation) {
     if (text.trim().length == 0) {
         return "";
@@ -95,4 +95,3 @@ function formatJsDocBlock(text, indentation) {
     const i = indentation !== null && indentation !== void 0 ? indentation : "";
     return [`${i}/**\n`, ...lines.map((l) => `${i} *${l}\n`), `${i} */`].join("");
 }
-exports.formatJsDocBlock = formatJsDocBlock;

package/dist/cjs/names.js

@@ -13,7 +13,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generatedJsonTypeName = exports.generatedShapeName = exports.generatedDescName = exports.generateFilePath = void 0;
+exports.generateFilePath = generateFilePath;
+exports.generatedDescName = generatedDescName;
+exports.generatedShapeName = generatedShapeName;
+exports.generatedJsonTypeName = generatedJsonTypeName;
 const codegenv1_1 = require("@bufbuild/protobuf/codegenv1");
 const reflect_1 = require("@bufbuild/protobuf/reflect");
 const safe_identifier_js_1 = require("./safe-identifier.js");
@@ -36,7 +39,6 @@ function generateFilePath(file, bootstrapWkt, filesToGenerate) {
     }
     return "./" + file.name + "_pb.js";
 }
-exports.generateFilePath = generateFilePath;
 /**
  * Return a safe identifier for a generated descriptor.
  */
@@ -49,7 +51,6 @@ function generatedDescName(desc) {
     }
     return name;
 }
-exports.generatedDescName = generatedDescName;
 /**
  * Return a safe identifier for a generated shape.
  */
@@ -61,7 +62,6 @@ function generatedShapeName(desc) {
     }
     return name;
 }
-exports.generatedShapeName = generatedShapeName;
 /**
  * Return a safe identifier for a generated JSON type.
  */
@@ -73,7 +73,6 @@ function generatedJsonTypeName(desc) {
     }
     return name;
 }
-exports.generatedJsonTypeName = generatedJsonTypeName;
 /**
  * Compute the ideal name for a generated descriptor.
  */

package/dist/cjs/parameter.d.ts

@@ -1,5 +1,12 @@
-import type { Target } from "./target.js";
 import type { RewriteImports } from "./import-path.js";
+/**
+ * Represents possible values of the plugin option `target`.
+ */
+export type Target = "js" | "ts" | "dts";
+/**
+ * Possible values of the plugin option `import_extension`.
+ */
+export type ImportExtension = "none" | "js" | "ts";
 /**
  * Standard plugin options that every ECMAScript plugin supports.
  */
@@ -12,11 +19,11 @@ export interface EcmaScriptPluginOptions {
      */
     targets: Target[];
     /**
-     * Add an extension to every import, for example ".js" or ".ts".
+     * Add an extension to every import: "js" or "ts".
      *
-     * The default is "".
+     * The default is "none".
      */
-    importExtension: string;
+    importExtension: ImportExtension;
     /**
      * Generate `import` statements or `require()` calls.
      *

package/dist/cjs/parameter.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseParameter = void 0;
+exports.parseParameter = parseParameter;
 const error_js_1 = require("./error.js");
 function parseParameter(parameter, parseExtraOptions) {
     let targets = ["js", "dts"];
@@ -21,7 +21,7 @@ function parseParameter(parameter, parseExtraOptions) {
     let bootstrapWkt = false;
     let keepEmptyFiles = false;
     const rewriteImports = [];
-    let importExtension = "";
+    let importExtension = "none";
     let jsImportStyle = "module";
     const extraParameters = [];
     const extraParametersRaw = [];
@@ -89,7 +89,22 @@ function parseParameter(parameter, parseExtraOptions) {
                 break;
             }
             case "import_extension": {
-                importExtension = value === "none" ? "" : value;
+                switch (value) {
+                    case "none":
+                    case "":
+                        importExtension = "none";
+                        break;
+                    case "js":
+                    case ".js":
+                        importExtension = "js";
+                        break;
+                    case "ts":
+                    case ".ts":
+                        importExtension = "ts";
+                        break;
+                    default:
+                        throw new error_js_1.PluginOptionError(raw);
+                }
                 break;
             }
             case "js_import_style":
@@ -157,7 +172,6 @@ function parseParameter(parameter, parseExtraOptions) {
         throw new error_js_1.PluginOptionError(extraParametersRaw.join(","), err);
     }
 }
-exports.parseParameter = parseParameter;
 function splitParameter(parameter) {
     if (parameter.length == 0) {
         return [];

package/dist/cjs/run-node.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runNodeJs = void 0;
+exports.runNodeJs = runNodeJs;
 const error_js_1 = require("./error.js");
 const protobuf_1 = require("@bufbuild/protobuf");
 const wkt_1 = require("@bufbuild/protobuf/wkt");
@@ -55,7 +55,6 @@ function runNodeJs(plugin) {
         return;
     });
 }
-exports.runNodeJs = runNodeJs;
 /**
  * Read a stream to the end.
  */

package/dist/cjs/runtime-imports.js

@@ -13,13 +13,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRuntimeImports = void 0;
+exports.createRuntimeImports = createRuntimeImports;
 const import_symbol_js_1 = require("./import-symbol.js");
 const codegenv1_1 = require("@bufbuild/protobuf/codegenv1");
 function createRuntimeImports(bootstrapWkt) {
     return mapRecord(codegenv1_1.symbols, bootstrapWkt);
 }
-exports.createRuntimeImports = createRuntimeImports;
 function mapRecord(record, bootstrapWkt) {
     const result = Object.create(null);
     for (const [key, value] of Object.entries(record)) {

package/dist/cjs/safe-identifier.d.ts

@@ -1,5 +1,9 @@
 /**
- * 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.
  */

package/dist/cjs/safe-identifier.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeIdentifier = void 0;
+exports.safeIdentifier = safeIdentifier;
 /**
  * Names that cannot be used for identifiers, such as class names,
  * but _can_ be used for object properties.
@@ -80,11 +80,14 @@ const reservedIdentifiers = new Set([
     "Partial",
 ]);
 /**
- * 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.
  */
 function safeIdentifier(name) {
     return reservedIdentifiers.has(name) ? name + "$" : name;
 }
-exports.safeIdentifier = safeIdentifier;

package/dist/cjs/schema.d.ts

@@ -2,8 +2,7 @@ import type { DescEnum, DescExtension, DescFile, DescMessage, DescService } from
 import type { CodeGeneratorRequest } from "@bufbuild/protobuf/wkt";
 import { Edition } from "@bufbuild/protobuf/wkt";
 import type { FileInfo, GeneratedFile } from "./generated-file.js";
-import type { Target } from "./target.js";
-import type { EcmaScriptPluginOptions, ParsedParameter } from "./parameter.js";
+import type { EcmaScriptPluginOptions, ParsedParameter, Target } from "./parameter.js";
 /**
  * Schema describes the files and types that the plugin is requested to
  * generate.

package/dist/cjs/schema.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSchema = void 0;
+exports.createSchema = createSchema;
 const protobuf_1 = require("@bufbuild/protobuf");
 const wkt_1 = require("@bufbuild/protobuf/wkt");
 const reflect_1 = require("@bufbuild/protobuf/reflect");
@@ -59,7 +59,6 @@ function createSchema(request, parameter, pluginName, pluginVersion, minimumEdit
         },
     };
 }
-exports.createSchema = createSchema;
 function getFilesToGenerate(request, minimumEdition, maximumEdition) {
     if (minimumEdition > maximumEdition) {
         throw new Error(`configured minimumEdition ${editionToString(minimumEdition)} > maximumEdition ${editionToString(maximumEdition)} - please contact plugin author`);

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

@@ -13,7 +13,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDeclarationString = exports.getFeatureOptionStrings = exports.getComments = exports.getSyntaxComments = exports.getPackageComments = void 0;
+exports.getPackageComments = getPackageComments;
+exports.getSyntaxComments = getSyntaxComments;
+exports.getComments = getComments;
+exports.getFeatureOptionStrings = getFeatureOptionStrings;
+exports.getDeclarationString = getDeclarationString;
 const protobuf_1 = require("@bufbuild/protobuf");
 const reflect_1 = require("@bufbuild/protobuf/reflect");
 const wkt_1 = require("@bufbuild/protobuf/wkt");
@@ -25,7 +29,6 @@ function getPackageComments(desc) {
         wkt_1.FileDescriptorProtoSchema.field.package.number,
     ]);
 }
-exports.getPackageComments = getPackageComments;
 /**
  * Get comments on the syntax element in the protobuf source.
  */
@@ -34,7 +37,6 @@ function getSyntaxComments(desc) {
         wkt_1.FileDescriptorProtoSchema.field.syntax.number,
     ]);
 }
-exports.getSyntaxComments = getSyntaxComments;
 /**
  * Get comments on the element in the protobuf source.
  */
@@ -123,7 +125,6 @@ function getComments(desc) {
     }
     return findComments(file.proto.sourceCodeInfo, path);
 }
-exports.getComments = getComments;
 /**
  * Get feature options set on the element in the protobuf source. This returns
  * compact (e.g. fields) or regular options (e.g. files) as an array of strings.
@@ -147,7 +148,6 @@ function getFeatureOptionStrings(desc) {
     }
     return strings;
 }
-exports.getFeatureOptionStrings = getFeatureOptionStrings;
 /**
  * Return a string that matches the definition of a field in the protobuf
  * source. Does not take custom options into account.
@@ -225,7 +225,6 @@ function getDeclarationString(desc) {
     }
     return parts.join(" ");
 }
-exports.getDeclarationString = getDeclarationString;
 /**
  * Whether this field was declared with `required` in the protobuf source.
  */

package/dist/cjs/transpile.js

@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transpile = void 0;
+exports.transpile = transpile;
 const typescript_1 = __importDefault(require("typescript"));
 const vfs_1 = require("@typescript/vfs");
 /* eslint-disable import/no-named-as-default-member */
@@ -122,4 +122,3 @@ function transpile(files, transpileJs, transpileDts, jsImportStyle) {
     }
     return results;
 }
-exports.transpile = transpile;

package/dist/esm/generated-file.d.ts

@@ -48,6 +48,10 @@ export interface GeneratedFile {
      * Create a string literal.
      */
     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.

package/dist/esm/generated-file.js

@@ -58,6 +58,18 @@ export function createGeneratedFile(name, importPath, jsImportStyle, rewriteImpo
                 value: string,
             };
         },
+        array(elements) {
+            const p = [];
+            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",

package/dist/esm/import-path.d.ts

@@ -1,3 +1,4 @@
+import type { ImportExtension } from "./parameter.js";
 /**
  * A configuration for rewriting import paths, a feature mainly used for
  * remote code generation in the BSR npm registry, which makes it possible
@@ -42,7 +43,7 @@ export type RewriteImports = {
  * Apply import rewrites to the given import path, and change all .js extensions
  * to the given import extension.
  */
-export declare function rewriteImportPath(importPath: string, rewriteImports: RewriteImports, importExtension: string): string;
+export declare function rewriteImportPath(importPath: string, rewriteImports: RewriteImports, importExtension: ImportExtension): string;
 export declare const relativePathRE: RegExp;
 /**
  * Derives an ECMAScript module import path from a file path. For example,

package/dist/esm/import-path.js

@@ -39,9 +39,14 @@ export function rewriteImportPath(importPath, rewriteImports, importExtension) {
             break;
         }
     }
-    if (importExtension != ".js" && importPath.endsWith(".js")) {
-        importPath =
-            importPath.substring(0, importPath.length - 3) + importExtension;
+    if (importPath.endsWith(".js")) {
+        switch (importExtension) {
+            case "none":
+                return importPath.substring(0, importPath.length - 3);
+            case "ts":
+            case "js":
+                return importPath.substring(0, importPath.length - 2) + importExtension;
+        }
     }
     return importPath;
 }

package/dist/esm/index.d.ts

@@ -2,9 +2,8 @@ export type { Plugin } from "./plugin.js";
 export { runNodeJs } from "./run-node.js";
 export { createEcmaScriptPlugin } from "./create-es-plugin.js";
 export { getComments, getDeclarationString, getPackageComments, getSyntaxComments, } from "./source-code-info.js";
-export type { Target } from "./target.js";
 export type { Schema } from "./schema.js";
-export type { EcmaScriptPluginOptions } from "./parameter.js";
+export type { EcmaScriptPluginOptions, Target, ImportExtension, } from "./parameter.js";
 export type { GeneratedFile, FileInfo } from "./generated-file.js";
 export type { ImportSymbol } from "./import-symbol.js";
 export { createImportSymbol } from "./import-symbol.js";

package/dist/esm/parameter.d.ts

@@ -1,5 +1,12 @@
-import type { Target } from "./target.js";
 import type { RewriteImports } from "./import-path.js";
+/**
+ * Represents possible values of the plugin option `target`.
+ */
+export type Target = "js" | "ts" | "dts";
+/**
+ * Possible values of the plugin option `import_extension`.
+ */
+export type ImportExtension = "none" | "js" | "ts";
 /**
  * Standard plugin options that every ECMAScript plugin supports.
  */
@@ -12,11 +19,11 @@ export interface EcmaScriptPluginOptions {
      */
     targets: Target[];
     /**
-     * Add an extension to every import, for example ".js" or ".ts".
+     * Add an extension to every import: "js" or "ts".
      *
-     * The default is "".
+     * The default is "none".
      */
-    importExtension: string;
+    importExtension: ImportExtension;
     /**
      * Generate `import` statements or `require()` calls.
      *

package/dist/esm/parameter.js

@@ -18,7 +18,7 @@ export function parseParameter(parameter, parseExtraOptions) {
     let bootstrapWkt = false;
     let keepEmptyFiles = false;
     const rewriteImports = [];
-    let importExtension = "";
+    let importExtension = "none";
     let jsImportStyle = "module";
     const extraParameters = [];
     const extraParametersRaw = [];
@@ -86,7 +86,22 @@ export function parseParameter(parameter, parseExtraOptions) {
                 break;
             }
             case "import_extension": {
-                importExtension = value === "none" ? "" : value;
+                switch (value) {
+                    case "none":
+                    case "":
+                        importExtension = "none";
+                        break;
+                    case "js":
+                    case ".js":
+                        importExtension = "js";
+                        break;
+                    case "ts":
+                    case ".ts":
+                        importExtension = "ts";
+                        break;
+                    default:
+                        throw new PluginOptionError(raw);
+                }
                 break;
             }
             case "js_import_style":

package/dist/esm/safe-identifier.d.ts

@@ -1,5 +1,9 @@
 /**
- * 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.
  */

package/dist/esm/safe-identifier.js

@@ -77,7 +77,11 @@ const reservedIdentifiers = new Set([
     "Partial",
 ]);
 /**
- * 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.
  */

package/dist/esm/schema.d.ts

@@ -2,8 +2,7 @@ import type { DescEnum, DescExtension, DescFile, DescMessage, DescService } from
 import type { CodeGeneratorRequest } from "@bufbuild/protobuf/wkt";
 import { Edition } from "@bufbuild/protobuf/wkt";
 import type { FileInfo, GeneratedFile } from "./generated-file.js";
-import type { Target } from "./target.js";
-import type { EcmaScriptPluginOptions, ParsedParameter } from "./parameter.js";
+import type { EcmaScriptPluginOptions, ParsedParameter, Target } from "./parameter.js";
 /**
  * Schema describes the files and types that the plugin is requested to
  * generate.

package/package.json

@@ -1,8 +1,15 @@
 {
   "name": "@bufbuild/protoplugin",
-  "version": "2.0.0-beta.2",
-  "license": "(Apache-2.0 AND BSD-3-Clause)",
+  "version": "2.0.0-beta.3",
+  "license": "Apache-2.0",
   "description": "Helps to create your own Protocol Buffers code generators.",
+  "keywords": [
+    "protobuf",
+    "schema",
+    "typescript",
+    "ecmascript",
+    "protoc-plugin"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/bufbuild/protobuf-es.git",
@@ -28,7 +35,7 @@
     }
   },
   "dependencies": {
-    "@bufbuild/protobuf": "2.0.0-beta.2",
+    "@bufbuild/protobuf": "2.0.0-beta.3",
     "@typescript/vfs": "^1.5.2",
     "typescript": "5.4.5"
   },

package/dist/cjs/target.d.ts

@@ -1,4 +0,0 @@
-/**
- * Represents possible values of the plugin option `target`.
- */
-export type Target = "js" | "ts" | "dts";

package/dist/cjs/target.js

@@ -1,15 +0,0 @@
-"use strict";
-// 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.
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/esm/target.d.ts

@@ -1,4 +0,0 @@
-/**
- * Represents possible values of the plugin option `target`.
- */
-export type Target = "js" | "ts" | "dts";

package/dist/esm/target.js

@@ -1,14 +0,0 @@
-// 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.
-export {};