COMMENT_MESSAGE Lint rule exceptions for request/response types

[sarahegler]

Prototool has a lint rule MESSAGES_HAVE_SENTENCE_COMMENTS_EXCEPT_REQUEST_RESPONSE_TYPES.

Is there a way to achieve this same level of linting in buf? It seems that COMMENT_MESSAGE requires a comment for every message type, including RPC request/response message types.

If not, is this something you would consider adding?

[amckinney]

Thanks for issue @sarahegler - we'd definitely consider adding this one.

We'd probably just name it COMMENT_MESSAGE_EXCEPT_REQUEST_RESPONSE_TYPES in our case (for consistency with the rest of our lint rules). You'll need to configure it explicitly though - we won't add it to any of the lint categories that already exist (e.g. DEFAULT) since that'd be a backwards incompatible change.

We might not get to this immediately due to some other priorities, but stay tuned and we'll try to get this change in soon!

[sarahegler]

thanks so much @amckinney!

[bufdev]

I started working on this issue in https://github.com/bufbuild/buf/pull/1191 - it's non-trivial, but consider this accepted as an issue we should work on eventually.