https://github.com/protostuff/protostuff-compiler

Protobuf parser, java code and documentation generator
https://github.com/protostuff/protostuff-compiler

java protobuf protobuf-compiler protostuff

Last synced: 3 months ago
JSON representation

Protobuf parser, java code and documentation generator

• Host: GitHub
• URL: https://github.com/protostuff/protostuff-compiler
• Owner: protostuff
• License: apache-2.0
• Created: 2015-03-21T22:07:04.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-06-15T17:14:14.000Z (about 3 years ago)
• Last Synced: 2025-04-15T00:15:36.612Z (3 months ago)
• Topics: java, protobuf, protobuf-compiler, protostuff
• Language: Java
• Homepage:
• Size: 1.54 MB
• Stars: 57
• Watchers: 9
• Forks: 30
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Protocol Buffers parser and code generator

------------------------------------------

[![Build Status](https://travis-ci.org/protostuff/protostuff-compiler.svg?branch=master)](https://travis-ci.org/protostuff/protostuff-compiler)

This project contains following modules:

1. `protostuff-parser` - ANTLR4-based parser for proto2/proto3 files. Parsing result is represented as an object model, containing all the information from proto files. 

2. `protostuff-generator` - code generator; current version can generate java code (for `protostuff` runtime library) and HTML documentation.

4. `protostuff-cli` - command-line interface.

5. `protostuff-maven-plugin` - maven plugin.

Usage

-----

* [maven plugin](https://github.com/protostuff/protostuff-compiler/wiki/Maven-Plugin)

* [command-line interface](https://github.com/protostuff/protostuff-compiler/wiki/Command-line-interface)

* [gradle](https://github.com/protostuff/protostuff-compiler/wiki/Gradle)

 

```xml

    

        

            

                protostuff-maven-plugin

                io.protostuff

                2.2.18

                

                    

                        generate-java-sources

                        generate-sources

                        

                            java

                        

                    

                

            

        

    

```

Java Source Code Generator

--------------------------

Current status: development in progress.

Generated code API: [draft](http://protostuff.github.io/documentation/compiler/java/generated-code).

Documentation Generator

-----------------------

`protostuff-compiler` can generate html from proto files.

Sample output: http://protostuff.github.io/samples/protostuff-compiler/html/#com.example.Address

This generator is an alternative to https://github.com/estan/protoc-gen-doc

Requirements

------------

| Component                                 | Version   |

|-------------------------------------------|-----------|

| JDK                                       | 11+       |  

| [Apache Maven](https://maven.apache.org/) | 3.6+       |

Build

-----

```

mvn clean install

```