protocolbuffers/protobuf

UML Class Diagrams

Fechada

#6.043 aberto em 16 de abr. de 2019

Ver no GitHubGuia do colaborador
 (4 comentários) (4 reações) (0 responsável)C++ (16.128 forks)batch import
help wantedproto3

Métricas do repositório

Stars
 (71.223 estrelas)
Métricas de merge de PR
 (Mesclagem média 2d 11h) (185 fundiu PRs em 30d)

Description

What language does this apply to? If it's a proto syntax change, is it for proto2 or proto3? proto3 If it's about generated code change, what programming language? any

Describe the problem you are trying to solve.

It would be very useful to generate class diagrams based on protobuf message definitions, including the members/fields of each class, as well as the class relationships.

Describe the solution you'd like

A script or command-line utility to output images (e.g. png) or something like GraphViz files with the generated UML diagrams.

Describe alternatives you've considered

I've looked into protoc-gen-uml and protobuf2uml but both tools lack useful documentation and neither are actively maintained.

Guia do colaborador

Direção de pesquisa
Investigue os plugins protoc existentes, como protoc gen uml e protobuf2uml, para entender suas abordagens. Em seguida, explore o descriptor.proto do protobuf e a interface de plugin no repositório protobuf (por exemplo, src/google/protobuf/compiler/plugin.proto). Considere gerar arquivos GraphViz DOT para representação de diagramas de classes. Avalie se um novo plugin protoc ou um script autônomo seria mais apropriado. Verifique os comentários da issue para qualquer contexto adicional da comunidade.
Pilha de tecnologia
None
Domain
documentationdeveloper experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
4
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Mais de 1 semana
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Protobuf basicsGraphVizUML fundamentalsProtoc plugin API
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
25