feat(cli): add cvs man command - #344
Open
speriaswamy-amd wants to merge 1 commit into
Open
Conversation
AIMVT-276
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part 11 of 14 in a stack for AIMVT-276.
Base: #343.
Why
With
man_lib(introspection) andconfig_registry(test-to-schema mapping)both in place, this wires them into a user-facing command:
cvs man [<test>] [<parameter>], so config parameters are documented straight fromthe pydantic schemas that validate them instead of scattered JSON comments.
What changed
cvs/cli_plugins/man_plugin.py: a thirdListPluginsubclass. Withno args, lists documented tests; with a test name, renders its full config
doc (text or
--json); with a parameter name, explains just thatparameter. Unknown test/parameter names exit non-zero with the error on
stderr in JSON mode.
cvs/cli_plugins/unittests/test_man_plugin.py.cvs/unittests/test_main.py's expected plugin order to includeman.