Skip to content

Update non_optional_string_data_conversion rule docs and examples to make it more clear #6088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update non_optional_string_data_conversion rule docs and examples to make it more clear #6088

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions Source/SwiftLintBuiltInRules/Rules/Lint/NonOptionalStringDataConversionRule.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@
var configuration = SeverityConfiguration<Self>(.warning)
static let description = RuleDescription(
identifier: "non_optional_string_data_conversion",
name: "Non-optional String -> Data Conversion",
description: "Prefer non-optional `Data(_:)` initializer when converting `String` to `Data`",
name: "Non-optional String <-> Data Conversion",
description: "Prefer the non-optional initializers when converting between `String` and `Data` (e.g. `Data(_:)` and `String(decoding:as:)`)",

Check failure on line 9 in Source/SwiftLintBuiltInRules/Rules/Lint/NonOptionalStringDataConversionRule.swift

View workflow job for this annotation

GitHub Actions / Lint Swift 

Line should be 120 characters or less; currently it has 149 characters (line_length)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you are still interested in providing extended documentation for this rule, please let the description property as it is and prefer the optional rationale property. It serves exactly this purpose.

kind: .lint,
nonTriggeringExamples: [
Example("Data(\"foo\".utf8)")
Example("Data(\"foo\".utf8)"),
Example("String(decoding: data, as: UTF8.self)"),
],
triggeringExamples: [
Example("\"foo\".data(using: .utf8)")
Example("\"foo\".data(using: .utf8)"),
Example("String(data: data, encoding: .utf8)"),
]
)
}
Expand Down
Loading