@bufbuild/protoc-gen-es 0.3.0 → 0.5.0

package/README.md

@@ -1,38 +1,11 @@
 # @bufbuild/protoc-gen-es
 
-The code generator for Protocol Buffers for ECMAScript. For example, the 
-following definition:
-
-```protobuf
-message Person {
-  string name = 1;
-  int32 id = 2;  // Unique ID number for this person.
-  string email = 3;
-}
-```
-
-Is compiled to an ECMAScript class that can be used like this:
-
-```typescript
-let pete = new Person({
-  name: "pete",
-  id: 123
-});
-
-let bytes = pete.toBinary();
-pete = Person.fromBinary(bytes);
-pete = Person.fromJsonString('{"name": "pete", "id": 123}');
-```
-
-Learn more about the project at [github.com/bufbuild/protobuf-es](https://github.com/bufbuild/protobuf-es).
-
+The code generator plugin for Protocol Buffers for ECMAScript.  Learn more about the project at [github.com/bufbuild/protobuf-es](https://github.com/bufbuild/protobuf-es).
 
 ## Installation
 
-`protoc-gen-es` is a code generator plugin for Protocol Buffer compilers,
-like [buf](https://github.com/bufbuild/buf) and [protoc](https://github.com/protocolbuffers/protobuf/releases).
-It generates base types - messages and enumerations - from your Protocol Buffer 
-schema. The generated code requires the runtime library [@bufbuild/protobuf](https://www.npmjs.com/package/@bufbuild/protobuf).
+`protoc-gen-es` generates base types - messages and enumerations - from your Protocol Buffer 
+schema. The generated code requires the runtime library [@bufbuild/protobuf](https://www.npmjs.com/package/@bufbuild/protobuf).  It is compatible with Protocol Buffer compilers  like [buf](https://github.com/bufbuild/buf) and [protoc](https://github.com/protocolbuffers/protobuf/releases).
 
 To install the plugin and the runtime library, run:
 
@@ -121,14 +94,29 @@ Multiple values can be given by separating them with `+`, for example
 `target=js+dts`.
 
 By default, we generate JavaScript and TypeScript declaration files, which
-produces the smallest code size. If you prefer to generate TypeScript, use
-`target=ts`.
+produces the smallest code size and is the most compatible with various 
+bundler configurations. If you prefer to generate TypeScript, use `target=ts`.
+
+### `import_extension=.js`
+
+By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
+(and all other plugins based on [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin))
+uses a `.js` file extensions in import paths, even in TypeScript files.
+
+This is unintuitive, but necessary for [ECMAScript modules in Node.js](https://www.typescriptlang.org/docs/handbook/esm-node.html).
+Unfortunately, not all bundlers and tools have caught up yet, and Deno 
+requires `.ts`. With this plugin option, you can replace `.js` extensions 
+in import paths with the given value. For example, set
+
+- `import_extension=none` to remove the `.js` extension
+- `import_extension=.ts` to replace the `.js` extension with `.ts`
+
 
 ### `keep_empty_files=true`
 
-By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es) 
-(and all other plugins based on [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin)) 
-omit empty files from the plugin output. This option disables pruning of 
-empty files, to allow for smooth interoperation with Bazel and similar 
+By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
+(and all other plugins based on [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin))
+omit empty files from the plugin output. This option disables pruning of
+empty files, to allow for smooth interoperation with Bazel and similar
 tooling that requires all output files to be declared ahead of time.
 Unless you use Bazel, it is very unlikely that you need this option.

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bufbuild/protoc-gen-es",
-    "version": "0.3.0",
+    "version": "0.5.0",
     "description": "Protocol Buffers code generator for ECMAScript",
     "license": "Apache-2.0",
     "repository": {
@@ -20,10 +20,10 @@
     },
     "preferUnplugged": true,
     "dependencies": {
-        "@bufbuild/protoplugin": "0.3.0"
+        "@bufbuild/protoplugin": "0.5.0"
     },
     "peerDependencies": {
-        "@bufbuild/protobuf": "0.3.0"
+        "@bufbuild/protobuf": "0.5.0"
     },
     "peerDependenciesMeta": {
         "@bufbuild/protobuf": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoc-gen-es",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Protocol Buffers code generator for ECMAScript",
   "license": "Apache-2.0",
   "repository": {
@@ -20,10 +20,10 @@
   },
   "preferUnplugged": true,
   "dependencies": {
-    "@bufbuild/protoplugin": "0.3.0"
+    "@bufbuild/protoplugin": "0.5.0"
   },
   "peerDependencies": {
-    "@bufbuild/protobuf": "0.3.0"
+    "@bufbuild/protobuf": "0.5.0"
   },
   "peerDependenciesMeta": {
     "@bufbuild/protobuf": {