feat: add --warn-unused-ignores flag for detecting unnecessary slither-disable comments #2921
+349
−4
Conversation
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
…r-disable comments Implements issue crytic#1680 - Warn when slither-disable comment is no longer necessary. This feature adds the ability to detect and report slither-disable comments that do not actually suppress any findings, helping maintain clean codebases. Changes: - Add tracking infrastructure in SlitherCore for all ignore comments - Track which ignore comments are actually used when suppressing findings - Add --warn-unused-ignores CLI flag to enable warning output - Report unused ignore comments via logger.warning() - Add unit tests for the feature The implementation handles: - slither-disable-next-line comments - slither-disable-start/end block comments - Multiple detectors on the same comment - The "all" keyword - Empty detector lists (filtered out) - Whitespace in detector lists (stripped) Closes crytic#1680
Author
|
Implements #1680. Adds |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
--warn-unused-ignoresCLI flag to detect and report slither-disable comments that do not suppress any findingsImplementation Details
SlitherCorefor all ignore comments found during parsinglogger.warning()when the flag is enabledThe implementation handles:
slither-disable-next-linecommentsslither-disable-start/endblock commentsallkeywordTest plan
allkeywordCloses #1680