Refactor/exported #1299
Merged
Refactor/exported #1299
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
…h documentation information
…"stutter", and other nitties
ccoVeille
reviewed
Apr 7, 2025
ccoVeille
approved these changes
Apr 7, 2025
denisvmedia
reviewed
Apr 7, 2025
mfederowicz
pushed a commit
to mfederowicz/revive
that referenced
this pull request
Apr 18, 2025
* simplify comment analysis by just checking the first comment line with documentation information * nit refactorings: common func for adding failures, reduce the use of "stutter", and other nitties * removes use of "stutter" in test code * move string interpolation into addFailuref
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.
IMO the rule deserved a refactoring to keep it under control.
The main modification introduced by this PR is the replacement of
hasDocComment,normalizeTextandisOnlyDeprecationCommentby a single methodfirstCommentLine. This replacement is based on the fact that the only thing of interest when doing the check on comments is the first line of the actual documentation; that is the first line of comment that is neither a directive nor a deprecation comment block.The PR introduces other changes to reduce the complexity of some methods and gain in clarity.