errose28 commented on PR #3943:
URL: https://github.com/apache/ozone/pull/3943#issuecomment-1307946024
+1 for this effort to standardize the CLI. I've got a few thoughts on the
implementation:
- I don't think modifying the description for all the deprecated flags is
very helpful. Ideally we would have some way to hide those option formats from
the help output but still have the system accept them. Since picocli's hidden
property looks to apply to the whole option, I am not sure if this is possible
but it would be nice.
- Are we going to alias and update commands that are non-standard as well?
Like `cancelprepare` -> `cancel-prepare` for example?
- Are there ways to enforce the standard going forward?
- We could add a unit test using reflection to check that all option and
command annotations do not contain capital letters, one letter options begin
with 1 dash, and longer options begin with two dashes. That would help, but
still not catch things like --serviceid.
- Another interesting option is a github action that reminds
users/reviewers to make sure commands follow the standard whenever a file with
a picocli import is added or modified. Kind of out there but might be useful...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
