Mildm8nnered skip unit tests in magic numbers rule #4897
Merged
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
|
Should be resolved by #4897 |
SimplyDanny
approved these changes
Apr 15, 2023
| } | ||
|
|
||
| private extension ClassDeclSyntax { | ||
| func isTestClass(testParentClasses: Set<String>) -> Bool { |
There was a problem hiding this comment.
The isXCTestCase already exists on ClassDeclSyntax objects.
There was a problem hiding this comment.
I should have remembered that :-)
| """), | ||
| Example(""" | ||
| class FooTests: XCTestCase { | ||
| class Bar { |
There was a problem hiding this comment.
Nested classes are discussable if they are not themselves test classes. But I agree that this rule should be disabled in test code generally. So ignoring them as well is fine.
CHANGELOG.md
Outdated
| @@ -31,6 +31,11 @@ | |||
| [Martin Redington](https://github.com/mildm8nnered) | |||
| [#4819](https://github.com/realm/SwiftLint/issues/4819) | |||
|
|
|||
| * Adds `test_parent_classes` option to the `magic_numbers` rule. | |||
There was a problem hiding this comment.
Suggested change
| * Adds `test_parent_classes` option to the `magic_numbers` rule. | |
| * Adds `test_parent_classes` option to the `no_magic_numbers` rule. |
|
CR comments addressed |
|
Thank you for the fast implementation! |
mildm8nnered
deleted the
mildm8nnered-skip-unit-tests-in-magic-numbers-rule
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.
WIP
Fixes #4896
Adds a
test_parent_classesto the Magic Number Rule.Violations within a class that inherits directly from one of the specified parent classes (by default
XCTestCaseandQuickSpec) will be ignored.This includes violations within inner classes of a class that inherits directly from one of the specified parent classes.
If users wish to detect violations of the rule within unit tests, they can simply set
test_parent_classesto[].I also "aligned" some of the labels in other classes that also use a similar configuration (actually the same configuration, but typealiased). In some places we were referring to
testClasses, which is actuallytestParentClasses.