Repository navigation
Warn on unrecognized keys in target dictionaries - #1660
Open
FawwazLawal wants to merge 1 commit into
Open
FawwazLawal wants to merge 1 commit into
FawwazLawal wants to merge 1 commit into
Conversation
Adds a validation warning when a target dictionary contains keys not in Target.recognizedKeys, helping catch typos like `resources` instead of `sources`. Resolves yonaskolb#1645
This branch has not been deployed
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
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
Target.init(name:jsonDictionary:)silently ignores unknown keys, so a typo likeresourcesinstead ofsourcesproduces no output and no error. This adds a validation warning that names the target and the unrecognized key.A new
Target.recognizedKeysset (32 keys, includingplatformPrefixandplatformSuffixread atTarget.swift:217-218) is checked inSpecLoader.validateWarnings(). Unrecognized keys produce aSpecValidationError.unrecognizedTargetKeywarning with a message likeTarget "MyTarget" has unrecognized key "resources".Tests cover both the warning case and the clean-spec case. CHANGELOG entry added.
Note:
swift testcould not be run in this environment (Swift 6.2 build issue unrelated to this change).Resolves #1645