mirror of
https://codeberg.org/JasterV/granc.git
synced 2026-04-26 18:40:05 +00:00
c9ef611e07
This PR implements a new subcommand `doc` that generates markdown documentation for a given gRPC service! **Description** For the most part, the inner logic of this subcommand is the same as the `describe`, the only thing that changes is the way that the found descriptor is transformed to a final output. In this case, a `Packages` type has been implemented to transform a `ServiceDescriptor` into a map of `Package`s. Each package groups all the file descriptors with the same package name (or namespace). A `Package` contains all the necessary information for a file of documentation to be generated (All its contained services, messages and enum descriptors and its name). The output of this command is a folder with all the generated documentation, which contains a file per protobuf package. **Introduced the `granc-test-support` crate** * Renamed the `echo_service` crate as `granc-test-support`, providing both the definition of a protobuf service for integration testing and a function to compile protobuffer at runtime into a file descriptor (Potentially this could be used to let users pass a folder to a proto project in addition to the server reflection and the local file descriptor options. For example, the `call` command could compile a file descriptor on the fly from a folder containing a protobuffer project before making the call to the gRPC server. **Descriptor API Enhancements:** * Added `name`, `full_name`, and `package_name` methods to the `Descriptor` enum to simplify access to descriptor metadata. (`granc-core/src/client/types.rs`) **Dependency Management Improvements:** * Added grouping for gRPC-related dependencies in `dependabot.yml` for improved automated dependency updates. (`.github/dependabot.yml`)
24 lines
798 B
TOML
24 lines
798 B
TOML
[package]
|
|
authors = { workspace = true }
|
|
categories = ["network-programming", "command-line-utilities"]
|
|
description = "A dynamic gRPC CLI tool written in Rust (gRPC + Cranc, Crab in Catalan)"
|
|
edition = { workspace = true }
|
|
homepage = { workspace = true }
|
|
keywords = ["cli", "command-line", "grpc", "grpcurl", "curl"]
|
|
license = { workspace = true }
|
|
name = "granc"
|
|
publish = true
|
|
readme = "../README.md"
|
|
repository = { workspace = true }
|
|
rust-version = { workspace = true }
|
|
version = "0.7.0"
|
|
|
|
[dependencies]
|
|
clap = { version = "4.5.56", features = ["derive"] }
|
|
colored = "3.1.1"
|
|
granc_core = { path = "../granc-core" }
|
|
serde_json = { workspace = true }
|
|
tokio = { workspace = true, features = ["rt-multi-thread", "macros"] }
|
|
|
|
[dev-dependencies]
|
|
granc-test-support = { path = "../granc-test-support" }
|