uber/prototoolArchived
Prototool
Prototool ist ein Entwicklungs-Toolkit für Protocol Buffers, das eine Suite an Tools zum Linting, Formatieren und Generieren von Code aus Schemadateien bereitstellt. Es fungiert als System zur Verwaltung des Lebenszyklus von Protocol-Buffer-Definitionen über ein Command-Line-Interface.
Das Toolkit zeichnet sich durch einen Detektor für Breaking Changes aus, der verschiedene Versionen von Definitionen vergleicht, um inkompatible Änderungen an der Schnittstelle oder am Quellcode zu identifizieren. Es enthält zudem ein gRPC-Client-Interface, das in der Lage ist, Endpunkte mittels JSON-Anfragen durch dynamische Kompilierung von Protobuf-Definitionen aufzurufen.
Das Projekt deckt breite Funktionsbereiche ab, einschließlich Schema-Validierung und Style-Durchsetzung, sprachspezifischer Code-Stub-Generierung und automatisierter Verwaltung von Compiler-Binaries. Es bietet zudem Dienstprogramme für den Export von File-Descriptor-Sets und die Generierung von Schemadateien mit automatisiertem 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.
