Reverse Data -> String conversion rule #5601
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
samrayner
force-pushed
the
samrayner/5263-reverse-data-string-conversion-rule
branch
from
8f22541
to
6bca4f2
Compare
2 tasks
samrayner
force-pushed
the
samrayner/5263-reverse-data-string-conversion-rule
branch
from
6bca4f2
to
f0d657d
Compare
Source/SwiftLintBuiltInRules/Rules/Lint/OptionalDataStringConversionRule.swift
Outdated
Show resolved
Hide resolved
…ersionRule.swift Co-authored-by: Ben P. <benj.c.palmer@gmail.com>
5 tasks
SimplyDanny
approved these changes
Jun 10, 2024
| @@ -10,7 +10,10 @@ | |||
|
|
|||
| #### Enhancements | |||
|
|
|||
| * None. | |||
| * Add new `optional_data_string_conversion` rule to enforce | |||
| failable conversions of `Data` -> UTF-8 `String`. | |||
There was a problem hiding this comment.
Please append two spaces to the end of the description. They are required to enforce a line break in the rendered Markdown.
Comment on lines
+30
to
+31
| * Revert `optional_data_string_conversion` enforcing | ||
| non-failable conversions of `Data` -> UTF-8 `String`. |
There was a problem hiding this comment.
Suggested change
| * Revert `optional_data_string_conversion` enforcing | |
| non-failable conversions of `Data` -> UTF-8 `String`. | |
| * Revert the part of the `non_optional_string_data_conversion` | |
| rule that enforces non-failable conversions of `Data` -> UTF-8 | |
| `String`. This is due to the fact that the data to be converted | |
| can be arbitrary and especially doesn't need to represent a valid | |
| UTF-8-encoded string. |
Please append two spaces to the end of the description. They are required to enforce a line break in the rendered Markdown.
Also, this should go into the "Breaking" section.
| @@ -5,16 +5,14 @@ struct NonOptionalStringDataConversionRule: Rule { | |||
| var configuration = SeverityConfiguration<Self>(.warning) | |||
| static let description = RuleDescription( | |||
| identifier: "non_optional_string_data_conversion", | |||
| name: "Non-Optional String <-> Data Conversion", | |||
| description: "Prefer using UTF-8 encoded strings when converting between `String` and `Data`", | |||
| name: "Non-Optional String -> Data Conversion", | |||
There was a problem hiding this comment.
Suggested change
| name: "Non-Optional String -> Data Conversion", | |
| name: "Non-optional String -> Data Conversion", |
| name: "Non-Optional String <-> Data Conversion", | ||
| description: "Prefer using UTF-8 encoded strings when converting between `String` and `Data`", | ||
| name: "Non-Optional String -> Data Conversion", | ||
| description: "Prefer using non-optional Data(_:) when converting a UTF-8 String to Data", |
There was a problem hiding this comment.
Suggested change
| description: "Prefer using non-optional Data(_:) when converting a UTF-8 String to Data", | |
| description: "Prefer non-optional `Data(_:)` initializer when converting `String` to `Data`", |
| static let description = RuleDescription( | ||
| identifier: "optional_data_string_conversion", | ||
| name: "Optional Data -> String Conversion", | ||
| description: "Prefer using failable String(data:encoding:) when converting from `Data` to a UTF-8 `String`", |
There was a problem hiding this comment.
Suggested change
| description: "Prefer using failable String(data:encoding:) when converting from `Data` to a UTF-8 `String`", | |
| description: "Prefer failable `String(data:encoding:)` initializer when converting `Data` to `String`", |
|
Please run |
2 tasks
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.
This reverses the Data -> String portion of this PR by introducing a new rule, following feedback on the original issue. It leaves the String -> Data portion of the original rule unchanged.