Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add buf inspect command to print information on types in a clean way similar to ls-files #3101

Open
remyleone opened this issue Jun 20, 2024 · 1 comment
Labels
Feature New feature or request

Comments

@remyleone
Copy link

Feature

As a maintainer of custom generator I would like to have a view of all the different types that I'm using in my protobuf files.

It would be helpful to see what protobuf files are using which kind of types.

buf ls-types my_proto.proto

In case some types are deprecated, it would be helpful to be able to locate them.

Having statistics about the most used kind of types could also be helpful.

buf ls-types --report my_proto.proto
12 string
8 int
1 google.type.Decimal

Where am I using one of?
What are all the packages that are presents

buf ls-packages
buf ls-methods

Where am I using particular features of protobuf (about such and such editions for instance).
Having this kind of inventory could really help maintenance locate usage and plan migration accordingly.

@remyleone remyleone added the Feature New feature or request label Jun 20, 2024
@bufdev
Copy link
Member

bufdev commented Jun 20, 2024

This is a fair feature request - at first glance, I'd recommend collapsing this down into a buf inspect sub-command`, we will want to think about the UX a little bit. Give us a bit to think about that and we'll get back to you.

@bufdev bufdev changed the title buf ls-types/ls-packages/ls-methods/ls-enums Add buf inspect command to print information on types in a clean way similar to ls-files Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants