Add rules to discourage #file and #filePath #231
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
calda
reviewed
Jun 15, 2023
calda
reviewed
Jun 15, 2023
calda
approved these changes
Jun 15, 2023
|
@jqsilver, could you also add a lint rule for this to https://github.com/airbnb/swift/blob/master/Sources/AirbnbSwiftFormatTool/swiftlint.yml? |
calda
reviewed
Jun 15, 2023
Co-authored-by: Cal Stephens <cal@calstephens.tech>
Co-authored-by: Cal Stephens <cal@calstephens.tech>
Co-authored-by: Cal Stephens <cal@calstephens.tech>
|
@calda I added a lint rule for |
|
We can follow how the |
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.
Summary
Add lint rules to discourage the use of
#fileand#filePathliterals (macros in 5.9).In addition, my editor removed some trailing whitespace - let me know if I should revert that.
Reasoning
#file's behavior is changing in future Swift versions (https://developer.apple.com/documentation/swift/file), from the problematic behavior of#filePathto the more ideal behavior of#fileID. We should just use the literal/macro with explicit and unchanging behavior.#filePathsays "Because #fileID doesn’t embed the full path to the source file, unlike #filePath, it gives you better privacy and reduces the size of the compiled binary. Avoid using #filePath outside of tests, build scripts, or other code that doesn’t become part of the shipping program." https://developer.apple.com/documentation/swift/filepath, so we should reflect this guidance in our lint rules.Please react with 👍/👎 if you agree or disagree with this proposal.