https://github.com/freenowtech/protoc-wrapper

A simple wrapper for Google Protocol Buffer's "protoc" utility
https://github.com/freenowtech/protoc-wrapper

Last synced: 10 days ago
JSON representation

A simple wrapper for Google Protocol Buffer's "protoc" utility

• Host: GitHub
• URL: https://github.com/freenowtech/protoc-wrapper
• Owner: freenowtech
• License: apache-2.0
• Created: 2019-07-02T12:10:06.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-25T13:10:54.000Z (almost 2 years ago)
• Last Synced: 2023-03-02T21:56:16.892Z (almost 2 years ago)
• Language: Shell
• Homepage:
• Size: 22.5 KB
• Stars: 8
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        

# Protoc Wrapper

A simple wrapper for Google Protocol Buffer's "protoc" utility

## Troubleshooting ⚠️

You might encounter issues running this tool on ARM processors, e.g. on new MacBooks with M1+ processors. 

This can be quick fixed by upgrading Protoc Wrapper to the latest version with following command:

```sh

./protocw --self-update

```

## Install

Open the target folder (usually the root of the project) in terminal and paste:

```bash

sh -c "$(curl -fsSL https://raw.githubusercontent.com/freenowtech/protoc-wrapper/master/install.sh)"

```

Follow the instruction to set the target protoc version

## Commit

After that you'll have 2 new files:

* `protocw`: the executable wrapper

* `protocw.properties`: the config file where the target version is set

Additionally:

* If you are using Git, `.protocw` folder will be added to your `.gitignore`

* If you are using Maven, the installer will try to replace the existing binary call with a call to the wrapper

(If not using Git, please make sure `.protocw` folder is marked as ignored on your VCS of choice)

## Usage

Run `./protocw [args]` when you would normally run `protoc [args]` 

Run `./protocw --configure` to setup the target protoc version

Run `./protocw --self-update` to update the wrapper to the latest version

Run `./protocw --help` to see the wrapper help and protoc help at once

## Author  

Lucas Laurindo dos Santos

https://github.com/lucasls