protostuff/protostuff-compiler

Protobuf parser, java code and documentation generator

Protocol Buffers parser and code generator

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.
3. protostuff-cli - command-line interface.
4. protostuff-maven-plugin - maven plugin.

Usage

• maven plugin
• command-line interface
• gradle

    <build>
        <plugins>
            <plugin>
                <artifactId>protostuff-maven-plugin</artifactId>
                <groupId>io.protostuff</groupId>
                <version>2.2.18</version>
                <executions>
                    <execution>
                        <id>generate-java-sources</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>java</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

Java Source Code Generator

Current status: development in progress.

Generated code API: draft.

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	3.6+

Build

mvn clean install