Allow prefer_key_paths to ignore identity closures ({ $0 })
#6068
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
Add new `ignore_identity_closures` parameter to `prefer_key_paths` rule
to skip conversion of identity closures (`{ $0 }`) to identity key
paths (`\self`).
Add a small note to the rule description stating that identity key path
conversion is Swift 6+ only.
2 tasks
Generated by 🚫 Danger |
2 tasks
SimplyDanny
requested changes
Jun 19, 2025
| * None. | ||
| * Add new `ignore_identity_closures` parameter to `prefer_key_paths` rule to skip conversion of identity closures | ||
| (`{ $0 }`) to identity key paths (`\self`). | ||
| Add a small note to the rule description stating that identity key path conversion is Swift 6+ only. |
There was a problem hiding this comment.
Let's have the note here as well instead of a reference to the note:
Suggested change
| Add a small note to the rule description stating that identity key path conversion is Swift 6+ only. | |
| Note that identity key paths are only support from Swift 6 on, hence this option | |
| will be implicitly ignored/set to `true` when SwiftLint detects a Swift <6 compiler | |
| to avoid causing compilation errors. |
| * Add new `ignore_identity_closures` parameter to `prefer_key_paths` rule to skip conversion of identity closures | ||
| (`{ $0 }`) to identity key paths (`\self`). | ||
| Add a small note to the rule description stating that identity key path conversion is Swift 6+ only. | ||
| [p4checo](https://github.com/p4checo) |
There was a problem hiding this comment.
Please reference the issue here as well.
Comment on lines
+10
to
+13
| private static let extendedModeAndIgnoreIdentity = [ | ||
| "restrict_to_standard_functions": false, | ||
| "ignore_identity_closures": true, | ||
| ] |
There was a problem hiding this comment.
This should work, shouldn't it?
Suggested change
| private static let extendedModeAndIgnoreIdentity = [ | |
| "restrict_to_standard_functions": false, | |
| "ignore_identity_closures": true, | |
| ] | |
| private static let extendedModeAndIgnoreIdentity = extendedMode + ignoreIdentity |
|
|
||
| static let description = RuleDescription( | ||
| identifier: "prefer_key_path", | ||
| name: "Prefer Key Path", | ||
| description: "Use a key path argument instead of a closure with property access", | ||
| description: """ |
There was a problem hiding this comment.
Let's keep the existing description as it's currently also used as the violation message and add a rational property instead to explain this detail.
| @@ -12,6 +17,8 @@ final class PreferKeyPathRuleTests: SwiftLintTestCase { | |||
| .with(nonTriggeringExamples: [ | |||
| Example("f.filter { a in b }"), | |||
| Example("f.g { $1 }", configuration: Self.extendedMode), | |||
| Example("f { $0 }", configuration: Self.extendedModeAndIgnoreIdentity), | |||
| Example("f.map { $0 }", configuration: Self.ignoreIdentity), | |||
There was a problem hiding this comment.
Let's also add a correction example to proof that nothing is changed with the option enabled.
| @@ -25,6 +35,8 @@ struct PreferKeyPathRule: Rule { | |||
| Example("f { (a, b) in a.b }", configuration: extendedMode), | |||
| Example("f { $0.a } g: { $0.b }", configuration: extendedMode), | |||
| Example("[1, 2, 3].reduce(1) { $0 + $1 }", configuration: extendedMode), | |||
| Example("f { $0 }", configuration: extendedModeAndIgnoreIdentity), | |||
| Example("f.map { $0 }", configuration: ignoreIdentity), | |||
There was a problem hiding this comment.
Let's also add a correction example.
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.
Add new
ignore_identity_closuresparameter toprefer_key_pathsrule to skip conversion of identity closures ({ $0 }) to identity key paths (\self).Add a small note to the rule description stating that identity key path conversion is Swift 6+ only.