JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q28652F
  • License MIT

multilanguage grpc protobuff generator for node. uses the protoc binary and supports multiple platforms and processors. forked from node-protoc.git.

Package Exports

  • protoc-helper
  • protoc-helper/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (protoc-helper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

npm version# protoc-helper multilanguage grpc protobuff generator for node. forked from node-protoc to add additional languages. uses the protoc binary and supports multiple platforms and processors. Please see Protobuf Plugin Installation to install the required plugins for your target language.

Install

  • local: npm i protoc-helper
  • cli-tool: npx install protoch

How to use

  • you can find a demoscript and the proto file in the scripts folder.

CLI (via npx global install) JavaScript npx protoch <language> <outputPath> <proto_file> <proto_path>

  • Import
   const {ProtobuffGenerator,createProtobuff} = require("protoc-helper")
  • create a path
const dir = String(__dirname)+"/"
  • generate the protobuffs without instance (array is supported)
createProtobuff("js",dir,path.join(dir,"helloworld.proto"))
  • generate the protobuffs using class instance
const generator = new ProtobuffGenerator()
generator.generateProtobuf("python",dir,"helloworld.proto",dir)
  • generate the protobuffs usings array for multiple files
const generator = new ProtobuffGenerator()
generator.generateProtobuf([["go",dir,"helloworld.proto",dir],["python",dir,"helloworld.proto",dir]])

@param language — The programming language for which the Protobuf file should be generated.
@param proto_path — The path to the Proto file that should be used as the source.
@param outputPath — The path where the generated Protobuf file should be saved
@returns — A promise that resolves with the output of the command execution or rejects with an error.


if you like this package, pls consider giving Jeppe’s and my repo a Star on github


Protobuf Plugin Installation

Go

Java

Python

C#

Ruby

Objective-C

PHP

Dart

Rust

Swift

Kotlin

Clone and build the plugin git clone https://github.com/grpc/grpc-kotlin.git cd grpc-kotlin/compiler ./gradlew installDist

Scala

  • Repository: https://github.com/scalapb/ScalaPB
  • Installation: scala // Add ScalaPB as a dependency to your sbt project libraryDependencies += "com.thesamet.scalapb" %% "compilerplugin" % "0.11.1"

JavaScript/TypeScript

NPX and additional args

you can use npx protoc or add your own arguments in the index.js:

   switch (language) {
            case 'go':
                // Example for Go --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative
                command = `npx protoc --go_out=${outputPath} --proto_path=${proto_path} ${proto_file}`;
                break;
            case 'java':
                // Example for Java
                command = `npx protoc --java_out=${outputPath} --proto_path=${proto_path} ${proto_file}`;
                break;
            case 'python':