Avoid a deprecation warning in FoundationXML when initializing XMLElement instances by initializing them as comments #5
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
…ult initializer, suppressing a warning in OSS XMLElement.
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.
When initialized via the default initializer, the swift-foundation version of XMLElement will initialize each instance as ".invalid" via the XMLNode implementation that it inherits from.
This will also print out a deprecation warning when compiling that discourages all uses of the default XMLElement initializer, as seen in https://github.com/apple/swift-corelibs-foundation/blob/main/Sources/FoundationXML/XMLNode.swift#L108
To mitigate this, this change initializes all of the XMLElement instances in this project as ".comment" instances. This does not change the output of XMLDocument in system Foundation or the open source swift-foundation as far as swift-ordered-plist-encoder's implementation is concerned, and it successfully suppresses the warning when compling.