Ignore no_magic_numbers violations if they are in an extension of a test class (only works in the same file)
#5146
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
mildm8nnered
force-pushed
the
mildm8nnered-ignore-magic-numbers-in-extensions-of-test-cases
branch
from
d423c44
to
fd94ec1
Compare
mildm8nnered
changed the title
no_magic_numbers violations if they are in an extension of a test class (only works in the same file)
SimplyDanny
reviewed
Aug 1, 2023
Source/SwiftLintBuiltInRules/Rules/Idiomatic/NoMagicNumbersRule.swift
Outdated
Show resolved
Hide resolved
Source/SwiftLintBuiltInRules/Rules/Idiomatic/NoMagicNumbersRule.swift
Outdated
Show resolved
Hide resolved
Source/SwiftLintBuiltInRules/Rules/Idiomatic/NoMagicNumbersRule.swift
Outdated
Show resolved
Hide resolved
Source/SwiftLintBuiltInRules/Rules/Idiomatic/NoMagicNumbersRule.swift
Outdated
Show resolved
Hide resolved
Source/SwiftLintBuiltInRules/Rules/Idiomatic/NoMagicNumbersRule.swift
Outdated
Show resolved
Hide resolved
Source/SwiftLintBuiltInRules/Rules/Idiomatic/NoMagicNumbersRule.swift
Outdated
Show resolved
Hide resolved
Source/SwiftLintBuiltInRules/Rules/Idiomatic/NoMagicNumbersRule.swift
Outdated
Show resolved
Hide resolved
Source/SwiftLintBuiltInRules/Rules/Idiomatic/NoMagicNumbersRule.swift
Outdated
Show resolved
Hide resolved
Source/SwiftLintBuiltInRules/Rules/Idiomatic/NoMagicNumbersRule.swift
Outdated
Show resolved
Hide resolved
mildm8nnered
force-pushed
the
mildm8nnered-ignore-magic-numbers-in-extensions-of-test-cases
branch
from
1fffbb4
to
77006c2
Compare
SimplyDanny
approved these changes
Aug 2, 2023
mildm8nnered
commented
Aug 3, 2023
My heart always sinks a little at first, but the code ends up so much better for your feedback :-) I wish I got code reviews like that in my day job. |
Haha ... thank you for the kind feedback! I appreciate your continuous and well thought out contributions. |
…test class (only works in the same file)
mildm8nnered
force-pushed
the
mildm8nnered-ignore-magic-numbers-in-extensions-of-test-cases
branch
from
f836039
to
7d21b47
Compare
This reverts commit 7d21b47.
mildm8nnered
deleted the
mildm8nnered-ignore-magic-numbers-in-extensions-of-test-cases
branch
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.
Ignores violations if they are present in an extension, if that extension extends a child of the specified
testParentClasses, as long as the class declaration is in the same source file.Partially resolves #5137
This was harder that I thought, and also more useful than expected, given the number of violations this (apparently correctly) fixes in the OSS tests.
We now keep track of class declarations, and whether they inherit from
testParentClassesor not.When we see a violation in an extension, unless we already know that it extends a test class, we add it to the violations.
If later in the file, we see the class declaration, and it extends one of the
testParentClasses, we remove the violations from the list.This should work no matter where in the file the class declaration occurs.