@bufbuild/protoc-gen-es 0.0.2-alpha.3 → 0.0.5

package/README.md

@@ -0,0 +1,86 @@
+# @bufbuild/protoc-gen-es
+
+[![npm](https://img.shields.io/npm/v/@bufbuild/protoc-gen-es?style=flat-square)](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
+
+A complete implementation of protocol buffers in TypeScript, 
+suitable for web browsers and Node.js.  
+Learn more at [github.com/bufbuild/protobuf-es](https://github.com/bufbuild/protobuf-es).
+
+This is a code generator plugin for `protoc` and [`buf`](https://github.com/bufbuild/buf).
+
+
+## Installation
+
+### With npm
+
+```shell
+npm install @bufbuild/protoc-gen-es
+```
+
+This will install the code generator plugin in `node_modules/.bin/protoc-gen-es`. 
+Note that npm does not add the executable to your `$PATH`. You can do so with:
+
+```shell
+PATH=$PATH:$(pwd)/node_modules/.bin
+```
+
+Note that `protoc-gen-es` is actually just a simple node script that selects the 
+correct precompiled binary for your platform. For example, if you are on a 32-bit 
+linux machine, the optional dependency `@bufbuild/protoc-gen-es-linux-32` is 
+automatically installed by `npm`, and our node script will run it. Note that this
+means you cannot move your `node_modules` directory to a different platform and
+run it. We recommend you run `npm ci` in CI or your docker images instead.
+
+
+### With yarn
+
+```shell
+yarn add @bufbuild/protoc-gen-es
+```
+
+Note that yarn v2 does not use a `node_modules` directory anymore. To find the path 
+where yarn stores the executable, run `yarn bin protoc-gen-es` (it is "unplugged" 
+automatically).
+
+Yarn supports installing dependencies for several platforms at the same time, by 
+adding the configuration field [`supportedArchitectures`](https://yarnpkg.com/configuration/yarnrc#supportedArchitectures)
+in your `.yarnrc.yml`.
+
+
+### With go
+
+Alternatively, you can install the plugin with `go`:
+
+```shell
+go install github.com/bufbuild/protobuf-es/cmd/protoc-gen-es@latest
+```
+
+If your go environment is set up correctly, the executable is now available on 
+your `$PATH`.
+
+You can always confirm successful installation with:
+```shell
+protoc-gen-es --version
+```
+
+
+
+## Plugin options
+
+### `target`
+
+This option controls whether the plugin generates JavaScript, TypeScript, 
+or TypeScript declaration files.
+
+Possible values:
+- `target=js` - generates a `_pb.js` file for every `.proto` input file.
+- `target=ts` - generates a `_pb.ts` file for every `.proto` input file.
+- `target=dts` - generates a `_pb.d.ts` file for every `.proto` input file.
+
+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`.
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoc-gen-es",
-  "version": "0.0.2-alpha.3",
+  "version": "0.0.5",
   "description": "protoc-gen-es",
   "license": "Apache-2.0",
   "repository": {
@@ -10,8 +10,9 @@
   "bin": {
     "protoc-gen-es": "bin/protoc-gen-es"
   },
+  "preferUnplugged": true,
   "peerDependencies": {
-    "@bufbuild/protobuf": "^0.0.2-alpha.3"
+    "@bufbuild/protobuf": "^0.0.5"
   },
   "peerDependenciesMeta": {
     "@bufbuild/protobuf": {
@@ -19,18 +20,18 @@
     }
   },
   "optionalDependencies": {
-    "@bufbuild/protoc-gen-es-darwin-64": "0.0.2-alpha.3",
-    "@bufbuild/protoc-gen-es-darwin-arm64": "0.0.2-alpha.3",
-    "@bufbuild/protoc-gen-es-windows-64": "0.0.2-alpha.3",
-    "@bufbuild/protoc-gen-es-windows-arm64": "0.0.2-alpha.3",
-    "@bufbuild/protoc-gen-es-windows-32": "0.0.2-alpha.3",
-    "@bufbuild/protoc-gen-es-linux-64": "0.0.2-alpha.3",
-    "@bufbuild/protoc-gen-es-linux-32": "0.0.2-alpha.3",
-    "@bufbuild/protoc-gen-es-linux-arm": "0.0.2-alpha.3",
-    "@bufbuild/protoc-gen-es-linux-arm64": "0.0.2-alpha.3",
-    "@bufbuild/protoc-gen-es-freebsd-64": "0.0.2-alpha.3",
-    "@bufbuild/protoc-gen-es-freebsd-arm64": "0.0.2-alpha.3",
-    "@bufbuild/protoc-gen-es-netbsd-64": "0.0.2-alpha.3",
-    "@bufbuild/protoc-gen-es-openbsd-64": "0.0.2-alpha.3"
+    "@bufbuild/protoc-gen-es-darwin-64": "0.0.5",
+    "@bufbuild/protoc-gen-es-darwin-arm64": "0.0.5",
+    "@bufbuild/protoc-gen-es-windows-64": "0.0.5",
+    "@bufbuild/protoc-gen-es-windows-arm64": "0.0.5",
+    "@bufbuild/protoc-gen-es-windows-32": "0.0.5",
+    "@bufbuild/protoc-gen-es-linux-64": "0.0.5",
+    "@bufbuild/protoc-gen-es-linux-32": "0.0.5",
+    "@bufbuild/protoc-gen-es-linux-arm": "0.0.5",
+    "@bufbuild/protoc-gen-es-linux-arm64": "0.0.5",
+    "@bufbuild/protoc-gen-es-freebsd-64": "0.0.5",
+    "@bufbuild/protoc-gen-es-freebsd-arm64": "0.0.5",
+    "@bufbuild/protoc-gen-es-netbsd-64": "0.0.5",
+    "@bufbuild/protoc-gen-es-openbsd-64": "0.0.5"
   }
 }