Introduce BUILD_ONLY_KNOWN_LOCALIZATIONS build setting #960
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
… languages added to Localizations in the project when set
Tantalum73
requested review from
aciidgh,
jakepetroules,
kulpreetchilana,
matthewseaman,
mhrawdon,
neonichu and
owenv
as code owners
|
|
||
| knownLocalizations.removeAll(where: { $0 == "Base" }) | ||
| if !knownLocalizations.isEmpty { | ||
| delegate.note("XCStrings will compile languages for known regions: \(knownLocalizations.joined(separator: ", "))") |
Contributor
There was a problem hiding this comment.
Just heads up that messages like this are going to show up for every xcstrings file, although in this particular case the specific file is not provided. Not saying it needs to be provided, but may appear as duplicate messages. Also for IB Compiler, etc.
| } | ||
|
|
||
| // This region is not supported, so it shouldn't build. | ||
| delegate?.note("Skipping .lproj directory '\(regionVariantName).lproj' because '\(regionVariantName)' is not in project's known localizations (BUILD_ONLY_KNOWN_LOCALIZATIONS is enabled)") |
Contributor
There was a problem hiding this comment.
Might want to look into specifying file paths for diagnostics like this. I don't mean in the message, but rather as part of the diag instance.
| return true | ||
| } | ||
|
|
||
| if regionVariantName == "mul" { |
matthewseaman
approved these changes
Dec 6, 2025
Contributor
|
@swift-ci test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 PR introduces a build setting
BUILD_ONLY_KNOWN_LOCALIZATIONS. Only languages explicitly added to the project's "Localizations" will be built when set.The new build setting allows developers to have work-in-progress translations in their project, which don't get built.
In the old world with only
.stringsfiles, it was possible to have partial translations in files that were on disk, but not referenced in the Xcode project. When localization was complete, they were simply added as a reference, and then they started contributing to the build.Since String Catalogs contain all localizations in a single file, it was not possible to not build content for a given language, making this workflow more complicated to achieve.
This build setting fixes that. When set, only languages in the list of "Localizations" in the project settings are built – including String Catalog content.
Now, for the time that a new language is brought up that isn't fully translated yet, developers enable
BUILD_ONLY_KNOWN_LOCALIZATIONS, and remove that language from the list of Localizations. The work on this language can continue, and when it's ready to ship they add it back to the list, or disableBUILD_ONLY_KNOWN_LOCALIZATIONS.