@byndyusoft/grpc-tools

    1.0.3 • Public • Published

    grpc-tools

    npm version npm downloads Build Status Build status

    A set of tools to simplify working with protobuf.js, protoc and its plugins.

    Why: generating code from proto files is a rather tricky thing because various utilities (protoc itself, pbjs, etc) have a lot of various options and it is also necessary to set proper include and plugins paths. Moreover some well known proto files, such as datetime.proto, openapiv2.proto and others are the part of other repositories and packages, so in order to use them, you have to copy them to your repository every time. As a result, you ought to perform a lot of routine every time.

    What: grpc-tools was created to simplify code generation and provide default include paths with well known proto files.

    Install

    npm i @byndyusoft/grpc-tools

    Usage

    We consider that a code generation is a part of build process, which can be started locally by developer and remotely by CI/CD. So there is no need to store artifacts of the proto files building in a repos since our package is helping easily automate this process. We recommend the following usage scenario:

    • install package to the devDependencies section of package.json
    • add build script in the scripts section of package.json, which describe code generation process using the commands provided by our package
    • execute code generation by running npm run build

    Short description of the commands provided by our package are listed below.

    js-protoc-gen

    Generates js files from proto files via pbjs from protobuf.js providing default include path. Code generation can be started by command

    $ js-protoc-gen -r greeter -t static-module -w commonjs --no-verify -o ./tests/generated/server/greeter_pb.js ./tests/protos/greeter.proto

    swagger-protoc-gen

    Generates swagger json from proto files via protoc-gen-swagger from grpc-gateway providing default include path. Code generation can be started by command

    $ swagger-protoc-gen --swagger_opt=json_names_for_fields=true --swagger_out=logtostderr=true:./tests/generated/server/ -I ./tests/protos/ greeter.proto

    Contributing

    To contribute, you will need to setup your local environment, see prerequisites. For the contribution and workflow guide, see package development lifecycle.

    A detailed overview on how to contribute can be found in the contributing guide.

    Prerequisites

    Make sure you have installed all of the following prerequisites on your development machine:

    Code conventions

    For Node.js code formatting is suggested to use prettier formatter (Visual Studio Code extension for Prettier). Shared prettier settings are saved at .prettierrc file

    General folders layout

    .vscode

    • configs for Visual Studio Code.

    build

    • scripts for the CI build process

    deps

    • repository submodules

    src

    • src/bin - tools entry points.
    • src/include - well known proto files, copied from other repositories, which are generated by command npm run build:copy. Folder is created automatically during the build process and was excluded from repository.
    • * - implementation of the service.

    tests

    • tests for the result of code generation.

    Package development lifecycle

    • Declare new tool in the bin section package.json
    • Implement tool entry point in src/bin
    • Implement tool logic in src
    • Add or addapt unit-tests (prefer before and simultaneously with coding)
    • Add or change the documentation as needed
    • Open pull request in the correct branch. Target the project's master branch

    Unit testing

    Files layout

    • src/protos - files on which code generation can be tested.
    • tests/generated — artifacts of the proto files compilation, which are generated by command npm run build. Folder is created automatically during the build process and was excluded from repository.
    • tests/\*.test.js — unit test cases

    Running tests

    Tests can be run using the following commands.

    $ npm i
    $ npm link
    $ npm run build
    $ npm t

    Maintainers

    @Byndyusoft/owners: https://github.com/orgs/Byndyusoft/teams/owners, github.maintain@byndyusoft.com

    Install

    npm i @byndyusoft/grpc-tools

    DownloadsWeekly Downloads

    2

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    16.3 MB

    Total Files

    55

    Last publish

    Collaborators

    • alexanderbyndyu
    • sadcitizen
    • dmitriy.litichevskiy
    • razonrus