Actually implement NoPlaygroundLiterals rule.
#613
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
This file has been stubbed out forever, so actually implement it.
It was originally meant to be a format rule, but those replacements
are either tricky or undesirable:
- `#fileLiteral` is implemented as `Bundle.main.url(forResource:withExtension:)`,
but I don't want to "endorse" `Bundle.main` since it's almost always better to
use `Bundle(for: AnyClass)` so that code works when it's pulled into a
framework target or when running unit tests.
- `#colorLiteral` and `#imageLiteral` are platform-dependent, being implemented
as either `{NS,UI}Color` and `{NS,UI}Image` respectively. Sometimes this can
be determined by checking for imports of `AppKit/Cocoa` or `UIKit`, but other
frameworks like `SwiftUI` can re-export those and thus the source file may not
actually have an import that we can unambiguously determine the right
replacement for. It can also be impossible to determine if there are
multi-platform conditions that import all of those modules.
So, we just make these literals lint warnings and give the user rough ideas
about how to fix them.
allevato
added a commit
to allevato/swift-format
that referenced
this pull request
Sep 14, 2023
Actually implement `NoPlaygroundLiterals` rule.
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 file has been stubbed out forever, so actually implement it. It was originally meant to be a format rule, but those replacements are either tricky or undesirable:
#fileLiteralis implemented asBundle.main.url(forResource:withExtension:), but I don't want to "endorse"Bundle.mainsince it's almost always better to useBundle(for: AnyClass)so that code works when it's pulled into a framework target or when running unit tests.#colorLiteraland#imageLiteralare platform-dependent, being implemented as either{NS,UI}Colorand{NS,UI}Imagerespectively. Sometimes this can be determined by checking for imports ofAppKit/CocoaorUIKit, but other frameworks likeSwiftUIcan re-export those and thus the source file may not actually have an import that we can unambiguously determine the right replacement for. It can also be impossible to determine if there are multi-platform conditions that import all of those modules.So, we just make these literals lint warnings and give the user rough ideas about how to fix them.