https://github.com/yeppha/node-protoc
A simple wrapper for the protoc.
https://github.com/yeppha/node-protoc
closure-compiler javascript linux node nodejs osx protobuf protocol-buffers windows
Last synced: 4 months ago
JSON representation
A simple wrapper for the protoc.
- Host: GitHub
- URL: https://github.com/yeppha/node-protoc
- Owner: YePpHa
- Created: 2017-02-08T22:45:02.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-08-20T19:55:21.000Z (11 months ago)
- Last Synced: 2025-11-27T09:34:52.425Z (7 months ago)
- Topics: closure-compiler, javascript, linux, node, nodejs, osx, protobuf, protocol-buffers, windows
- Language: JavaScript
- Homepage:
- Size: 2.37 MB
- Stars: 8
- Watchers: 1
- Forks: 17
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Protocol Buffers for Node
A wrapper in Node for the compiled protoc from https://github.com/protocolbuffers/protobuf.
> [!IMPORTANT]
>
> Starting with version v21.0.x, the npm package [protoc](https://www.npmjs.com/package/protoc)
> is maintained in the repository https://github.com/timostamm/protobuf-npm.
>
> You can install the latest version with:
>
> ```
> npm install --save-dev protoc@latest
> npx protoc --version
> ```
>
> Note that the JavaScript generator has been removed from `protoc`, and lives in a
> separate repository now: https://github.com/protocolbuffers/protobuf-javascript
> Consequently, the package `protoc` no longer provides an API to generate JavaScript
> code, but you can easily achieve the same functionality with a small function.
>
> Example script to call protoc from JS
>
> ```ts
> import { spawnSync } from "node:child_process";
> import { mkdtempSync, readdirSync, statSync } from "node:fs";
> import { join } from "node:path";
> import { tmpdir } from "node:os";
>
> function compile(files: string[]): string[] {
> const out = mkdtempSync(join(tmpdir(), "protoc-output"));
> // Just as an example, use --php_out to generate PHP code
> const ret = spawnSync(
> "protoc", ["--php_out=" + out, ...files],
> { encoding: "utf8"},
> );
> if (ret.status !== 0) {
> throw new Error(ret.stderr);
> }
> return readdirSync(out, { recursive: true, encoding: "utf8" }).filter((f) =>
> statSync(join(out, f)).isFile(),
> );
> }
>
> // Run with `npx node example.ts`
> console.log(compile(["proto/msg.proto"])); // [ 'Msg.php', 'GPBMetadata/Proto/Msg.php' ]
> ```
The information below applies to the package `protoc` version 1.1.3 and earlier:
## Version
It's currently using Protocol Buffers `v3.20.3`.
## Platforms
Google only provides binary files for Windows, Linux and OSX in x86_64 and x86_32.
## Examples
There's currently no documentation. Hopefully this example will help.
```JavaScript
var protoc = require("protoc");
protoc.library(["path/to/file.proto", "path/to/file2.proto"], function(err, files) {
if (err) {
console.error(err);
return;
}
// Handle the JavaScript Vinyl files.
// These files can be used in Google Closure Compiler,
// but they require the files in
// https://github.com/google/protobuf/tree/master/js
// ...
});
```
It's also possible to directly call the protoc binary file:
```
npx protoc --help
```