Add ignore_codingkeys parameter to nesting
#5650
Open
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
This only returns true when the name of the enum is CodingKeys and it conforms to CodingKey
This prevents nested CodingKeys (which may be necessary for functioning Codable conformance) from triggering nesting violations
Generated by 🚫 Danger |
SimplyDanny
requested changes
Jul 2, 2024
There was a problem hiding this comment.
Thank you for the contribution! Looks good in principle.
What about the following example?
struct Outer {
enum CodingKeys: String, CodingKey {
case id
struct S {}
}
}I think, the rule should trigger on S.
You need to run IntegrationTests locally and fix all linting issues it reports and update the configuration set reference file.
| @@ -184,6 +184,25 @@ public extension EnumDeclSyntax { | |||
| return rawValueTypes.contains(identifier) | |||
| } | |||
| } | |||
|
|
|||
| /// True if this enum is a `CodingKey` | |||
There was a problem hiding this comment.
Suggested change
| /// True if this enum is a `CodingKey` | |
| /// True if this enum is a `CodingKey`. For that, it has to be named `CodingKeys` and must conform to the `CodingKey` protocol. |
| @@ -184,6 +184,25 @@ public extension EnumDeclSyntax { | |||
| return rawValueTypes.contains(identifier) | |||
| } | |||
| } | |||
|
|
|||
| /// True if this enum is a `CodingKey` | |||
| var isCodingKey: Bool { | |||
There was a problem hiding this comment.
The enum itself is not a coding key, but it defines the coding keys, doesn't it? So what about the name definesCodingKeys instead?
| return false | ||
| } | ||
|
|
||
| guard self.name.text == "CodingKeys" else { |
There was a problem hiding this comment.
Suggested change
| guard self.name.text == "CodingKeys" else { | |
| guard name.text == "CodingKeys" else { |
Can also be added to the previous guard.
Comment on lines
+199
to
+203
| guard let identifier = element.type.as(IdentifierTypeSyntax.self)?.name.text else { | ||
| return false | ||
| } | ||
|
|
||
| return identifier == "CodingKey" |
There was a problem hiding this comment.
Suggested change
| guard let identifier = element.type.as(IdentifierTypeSyntax.self)?.name.text else { | |
| return false | |
| } | |
| return identifier == "CodingKey" | |
| element.type.as(IdentifierTypeSyntax.self)?.name.text == "CodingKey" |
| @@ -64,7 +64,9 @@ private extension NestingRule { | |||
| } | |||
|
|
|||
| override func visit(_ node: EnumDeclSyntax) -> SyntaxVisitorContinueKind { | |||
| validate(forFunction: false, triggeringToken: node.enumKeyword) | |||
| if !(configuration.ignoreCodingKeys && node.isCodingKey) { | |||
There was a problem hiding this comment.
Suggested change
| if !(configuration.ignoreCodingKeys && node.isCodingKey) { | |
| if !configuration.ignoreCodingKeys || !node.isCodingKey { |
| .init(""" | ||
| struct Outer { | ||
| struct Inner { | ||
| enum Example: String, CodingKey { |
There was a problem hiding this comment.
Suggested change
| enum Example: String, CodingKey { | |
| ↓enum Example: String, CodingKey { |
| @@ -15,6 +15,8 @@ struct NestingConfiguration: RuleConfiguration { | |||
| private(set) var alwaysAllowOneTypeInFunctions = false | |||
| @ConfigurationElement(key: "ignore_typealiases_and_associatedtypes") | |||
| private(set) var ignoreTypealiasesAndAssociatedtypes = false | |||
| @ConfigurationElement(key: "ignore_codingkeys") | |||
There was a problem hiding this comment.
Suggested change
| @ConfigurationElement(key: "ignore_codingkeys") | |
| @ConfigurationElement(key: "ignore_coding_keys") |
SimplyDanny
reviewed
Jul 2, 2024
| @@ -16,6 +16,10 @@ | |||
| improvements done in the [SwiftSyntax](https://github.com/apple/swift-syntax) | |||
| library. | |||
|
|
|||
| * Add `ignore_codingkeys` parameter to `nesting` rule. | |||
There was a problem hiding this comment.
Please explain briefly what this option does.
Suggested change
| * Add `ignore_codingkeys` parameter to `nesting` rule. | |
| * Add `ignore_coding_keys` parameter to `nesting` rule. |
|
FYI I'm out of town until next weekend. I'll jump back into this once I'm back |
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.
Resolves #5641
This very explicitly targets
enum's namedCodingKeyswhich conform toCodingKey. To provide an exception forCodableusers who have to provide custom keys.OK ✅
Not OK ❌