Cleanup CLI #255
Merged
Cleanup CLI #255
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
rafaelfranca
reviewed
Nov 7, 2022
| @@ -32,17 +32,6 @@ def initialize( | |||
| @relative_file_set = relative_file_set | |||
| end | |||
|
|
|||
| sig { returns(Result) } | |||
| def detect_stale_violations | |||
There was a problem hiding this comment.
Let's deprecate this command. It was added by our team long time ago, we don't use it, but nothing prevents people from using it. At least we should deprecate in the stable branch before our next release and remove on main.
There was a problem hiding this comment.
This was my hesitation with merging. I made sure we weren't using it, but I don't know about others. We could just kill them in the next major release, but deprecating this one sounds good to me.
gmcgibbon
force-pushed
the
cleanup_cli
branch
2 times, most recently
from
aeebd53
to
ed2e247
Compare
init does the same thing and this command is not documented.
Makes command parsing where clause easier to read.
This command's output is in check and isn't documented.
gmcgibbon
force-pushed
the
cleanup_cli
branch
from
ed2e247
to
6eeac84
Compare
rafaelfranca
approved these changes
Nov 8, 2022
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.
What are you trying to accomplish?
Clean up the CLI class.
What approach did you choose and why?
Clean up the CLI to declutter the command parsing where clause and clean up / deprecate old commands that aren't documented.
What should reviewers focus on?
This removes the
generate_configssubcommand and deprecates thedetect-stale-violationssubcommand.Type of Change
Additional Release Notes
This might be a breaking change if anyone is using the undocumented commands. Since we don't mention them anywhere, I think they are safe to delete.
Checklist