Feature request: buf config ls-modules

[doriable]

I am interested in a command that gives me the list of configured modules.

buf config ls-modules <path>

It takes up to one argument, which is a path to a module or workspace root (where the configuration file lives). This path defaults to . when left empty.

For example, if I have a workspace that has a v2 buf.yaml that looks like the following:

version: v2
name: buf.build/dkeung/playground
modules:
  - path: proto
    name: buf.build/foo/foo
  - path: vendor

In a directory tree that looks like the following:

$ tree
.
├── buf.yaml
├── proto
│       └── ...
├── vendor
│       └── ...
└── ...

I want something that does the following, assume all commands are run at .:

$ buf config ls-modules
Path            Name
proto           buf.build/foo/foo
vendor


$ buf config ls-modules --names-only
buf.build/foo/foo

$ buf config ls-modules --paths-only
proto
vendor

$ buf config ls-modules --names-only --paths-only
Failure: cannot set --names-only --paths-only together

The path will always be the module root and the name is the module name, if one is available. For remote modules, the root of a remote module is always ., since the remote reference will always "start at its root".

[doriable]

For v1 workspaces, I would expect the following:

version: v1
directories:
  - proto
  - vendor

# buf.yaml in proto
version: v1
name: buf.build/foo/foo

$ tree
.
├── buf.work.yaml
├── proto
│       └── buf.yaml
├── vendor
│       └── ...
└── ...


$ buf config ls-modules
Path            Name
proto           buf.build/foo/foo
vendor

$ buf config ls-modules --names-only
buf.build/foo/foo

$ buf config ls-modules --paths-only
proto
vendor

$ buf config ls-modules proto
Path       Name
.          buf.build/foo/foo

For v1 modules, it will always only ever print one module output:

# buf.yaml in proto
version: v1
name: buf.build/foo/foo

$ tree
.
├── proto
│       └── buf.yaml
└── ...

$ buf config ls-modules proto
Path       Name
.          buf.build/foo/foo

$ buf config ls-modules proto --names-only
buf.build/foo/foo

$ buf config ls-modules proto --paths-only
.