uber/prototoolArchived
Prototool
Prototool is a development toolkit for Protocol Buffers that provides a suite of tools for linting, formatting, and generating code from schema files. It functions as a system for managing the lifecycle of Protocol Buffer definitions through a command line interface.
The toolkit distinguishes itself by providing a breaking change detector that compares different versions of definitions to identify wire or source incompatible changes. It also includes a gRPC client interface capable of invoking endpoints using JSON requests by dynamically compiling Protobuf definitions.
The project covers broad capability areas including schema validation and style enforcement, language-specific code stub generation, and automated compiler binary management. It also provides utilities for file descriptor set export and schema file generation with automated boilerplate.
Features
- Breaking Change Detectors - Identifies wire and source incompatible changes by comparing serialized FileDescriptorSets between different versions of definitions.
- Protobuf Code Generators - Produces language-specific source code and file descriptor sets from Protocol Buffer definitions.
- Protobuf Formatters - Standardizes the layout of schema files by alphabetizing imports and applying consistent spacing.
- Protobuf Linters - Analyzes schema files against configurable rule groups to enforce naming conventions and structural requirements.
- Protobuf Style Rules - Provides static analysis of Protobuf schemas to enforce naming conventions and structural rules via AST traversal.
- API Specification Breaking Change Detectors - Compares different versions of Protobuf definitions to identify incompatible changes that could break service clients.
- Protobuf Stub Generators - Generates language-specific client and server stubs from Protocol Buffer interface definitions.
- Multi-Language Code Generators - Transforms schema definitions into source code for various languages using managed compiler versions.
- Protobuf Code Generators - Generates language-specific source code from Protobuf definitions using a configuration-driven template mapping.
- Style Enforcement Strategies - Validates schema files against a set of rules for naming, ordering, and structure to ensure consistency.
- JSON-to-gRPC Translation - Enables calling gRPC endpoints using JSON requests by dynamically compiling Protobuf definitions.
- Protobuf Syntax Validation - Validates schema files by compiling them without output stubs to ensure syntax correctness.
- Binary Cache Managers - Manages the downloading and caching of specific compiler binaries and type definitions to ensure consistent builds.
- Binary Process Wrappers - Wraps the official Protocol Buffer compiler to manage its installation and execution across different environments.
- Compiler Binary Management - Buf CLI & Automation downloads, caches, and updates the schema compiler and type definitions automatically or via configuration.
- gRPC Command-Line Clients - Provides a command-line interface for invoking gRPC methods and inspecting service definitions using JSON.
- Interactive Clients - Enables sending JSON requests to gRPC servers by dynamically compiling Protobuf files.
- gRPC API Testing - Sends JSON requests to gRPC endpoints by dynamically compiling Protobuf files to validate server behavior.
- Protocol Buffer Tools - Integrated suite for compiling, linting, and formatting Protobuf files.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
