Repository navigation
Warn on unrecognized keys in target dictionaries - #1660
Open
FawwazLawal wants to merge 2 commits into
Open
FawwazLawal wants to merge 2 commits into
FawwazLawal wants to merge 2 commits 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
|
@yonaskolb gentle ping to review this PR addressing #1645 when you get a chance. |
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 that lists the valid keys inline, so the fix is in the message itself:Target and key iteration are sorted, so a spec with several typos emits warnings in a stable order across runs.
Reproduction
A target spec that lists files under a top-level
resources:key rather than undersources:is accepted silently and leaves the project without those files.project.yml:Against XcodeGen 2.45.3:
Moving the
Resourcesdirectory undersources:on the same files, with nothing else changed, produces4andpresent. The four lines are the file'sPBXBuildFile,PBXFileReference, group listing and build-phase listing, not four copies. Both runs are silent, exit 0.With this change the same spec still generates and names the unrecognized key:
This PR applied to the broken spec: warning above, generation proceeds, exit 0. Count stays 0; the fix surfaces the discarded key, it does not include the file.
Generation continues and exits 0.
validateWarnings()was an existing stub inSpecLoaderwith a hard-coded empty array, andGenerateCommandalready caught any thrown error and routed it towarning(). The change populates that channel; it does not add a new abort path.Tests cover both the warning case and the clean-spec case. CHANGELOG entry added.
Local runs:
xcrun swift teston macOS exits 0, 246 tests across 5 xctest bundles, 0 failures;swift test --enable-test-discoveryinswift:6.1-nobleon Linux exits 0, 82 tests, 6 skipped, 0 failures.Resolves #1645