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.

Sign up for GitHub

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

Jump to bottom

[core] Stop printing CLI usage text when exiting due to invalid parameters #3427

Closed
oowekyala opened this issue Jul 29, 2021 · 0 comments · Fixed by #3781
Closed

[core] Stop printing CLI usage text when exiting due to invalid parameters #3427

oowekyala opened this issue Jul 29, 2021 · 0 comments · Fixed by #3781
Assignees
@oowekyala
Labels
an:enhancement An improvement on existing features / rules in:cli Affects the PMD Command Line Interface
Milestone
6.43.0

Comments

@oowekyala
Copy link
Member

Is your feature request related to a problem? Please describe.
When making a mistake in CLI parameters a wall of text is printed and the actual error message is completely drowned out. Also this is a real problem with the -help option. Because of #3424, pmd --help is actually incorrect (pmd -help should be used instead). But since the usage text is printed, we have the impression that it actually worked, only to be disappointed that this wall of text doesn't mention the CLI syntax. It comes off as buggy and unhelpful.

Describe the solution you'd like Just print the error message, followed by the line Run with --help to get more information or something like that. Note that --help doesn't exist yet (#3424)
@oowekyala oowekyala added an:enhancement An improvement on existing features / rules in:cli Affects the PMD Command Line Interface labels Jul 29, 2021
@oowekyala oowekyala added this to the 6.43.0 milestone Feb 12, 2022
@oowekyala oowekyala self-assigned this Feb 12, 2022
oowekyala added a commit to oowekyala/pmd that referenced this issue Feb 12, 2022
@oowekyala
Fix pmd#3427 - Stop printing usage test on error
583e025
@oowekyala oowekyala mentioned this issue Feb 12, 2022
Merged
4 tasks
adangel added a commit to adangel/pmd that referenced this issue Feb 19, 2022
@adangel
[doc] Update release notes (pmd#3427 pmd#3781)
9d2a10e
adangel added a commit to adangel/pmd that referenced this issue Feb 19, 2022
@adangel
Merge pull request pmd#3781 from oowekyala:issue3427-cli-help
84b026d 
[core] Fix pmd#3427 - Stop printing usage text on error pmd#3781
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@oowekyala oowekyala

Labels
an:enhancement An improvement on existing features / rules in:cli Affects the PMD Command Line Interface
Projects
None yet
Milestone
6.43.0
Development

Successfully merging a pull request may close this issue.

[core] Fix #3427 - Stop printing usage text on error oowekyala/pmd
1 participant
@oowekyala