chore: update cli yargs config to highlight "ruleset*" options are mutually exclusive. #308
Conversation
This file contains 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
zhaoyuheng200
force-pushed
the
yargs
branch
2 times, most recently
from
015af39
to
1da65c6
Compare
…ually exclusive. This should help clean up the function in index.js to *not* trying to figure out "is it a path/url/encoded" question. Signed-off-by: Neil Zhao <[email protected]>
|
LGTM |
hyandell
approved these changes
Jun 3, 2024
Signed-off-by: Neil Zhao <[email protected]>
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.
This should help clean up the
lintfunction in index.js to not trying to figure outis it a path/url/encodedquestion.Motivation
The current design of the
lintfunction inindex.jsspends much effort trying to figure out how to ingest ruleset config correctly.Adding
conflictsinyargscreates a 3-way option exclusion, so we can have better control over CLI option intake.I have some plan to update the
lintfunction to call a newlintEnginefunction, so the existing exposedlintfunction will remain the same, but we'll use a newlintEnginefunction to separaterulesetPath,rulesetUrlandrulesetEncoded.It would also help separate
--allowPathsand future--ignorePathsoption, since I don't see an easy way to add the proposed--ignorePathseasily in current setup.Proposed Changes
Add the conflicts to create a 3-way exclusion.
Test Plan
This should be expected behavior of how customer use the repolinter cli tool, and I'm not testing yargs here.
So I didn't add any additional testing.
Passed all existing tests.