Package Manager Localized Resources

SwiftPM のマニフェストにローカライズリソースを宣言する仕組みを追加します。リソースはビルド時に適切な場所へ配置され、ランタイムでは既存の Foundation API からそのまま参照できます。

デフォルトローカライゼーションの宣言

Package イニシャライザに、新しいオプションの defaultLocalization パラメータを追加します。これは実行環境にマッチするローカライズが存在しないときのフォールバックとして使われるロケールで、パッケージがローカライズリソースを含む場合は必須になります（未設定だとエラー）。値の型は IETF Language Tag をラップした LocalizationTag で、文字列リテラルからそのまま渡せます。

let package = Package(
    name: "BestPackage",
    defaultLocalization: "en",
    targets: [
        .target(name: "BestTarget", resources: [
            .process("Resources/Icon.png"),
        ])
    ]
)

ロケールの表記は、en や fr-CH のように 2 文字の ISO 639-1（または 3 文字の ISO 639-2）言語コードに、必要ならハイフン区切りで地域・方言コードを続ける IETF Language Tag 形式が推奨されます。

.lproj ディレクトリによるローカライズリソースの配置

ローカライズリソースの検出は、.process ルールの対象パス配下にある .lproj ディレクトリに基づいて行われます。ディレクトリ名の .lproj より前の部分がロケールを表し、たとえば en.lproj/ には英語版、fr-CH.lproj/ にはスイス向けフランス語版のリソースを置きます。Apple プラットフォームの Base Internationalization 用に、特別な Base.lproj/ も同様に扱われます。

.lproj 配下のファイルは、親ディレクトリに同じ名前で存在する「仮想的なリソース」のバリアントと見なされます。マニフェストからはその仮想パスを指定します。たとえば次のようなレイアウトでは、Resources/Icon.png を指定するだけで英仏両方のバリアントがひとまとまりのリソースとして扱われます。

Sources/BestTarget/Resources/
├── en.lproj/
│   └── Icon.png
└── fr.lproj/
    └── Icon.png

.target(name: "BestTarget", resources: [
    .process("Resources/Icon.png"),
])

明示的なローカライゼーション宣言

.lproj ディレクトリの外にあるファイルをローカライズ済みとして扱いたい場合のために、Resource.process に localization パラメータが追加されます。値は列挙型 LocalizationType の .default（デフォルトローカライゼーションのバリアント）または .base（Base Internationalization のバリアント）です。ローカライズされていないリソースと同じ場所にデフォルト版を置きつつ、別途のポストプロセスで他言語版を足すような運用に向いています。

.target(name: "BestTarget", resources: [
    .process("Resources", localization: .base),
])

なお、明示的な localization 宣言と .lproj ディレクトリ配置はいずれか一方のみを使うことが求められ、両方を併用するとエラーになります。

SwiftPM による診断

SwiftPM はローカライズリソースの構成ミスをビルド時に診断します。主なものは次のとおりです。

• ローカライズリソースがあるのに defaultLocalization が設定されていない（エラー）。
• .lproj ディレクトリの中にさらにサブディレクトリがある（エラー）。
• デフォルトロケール向けのバリアントが欠けている。このとき Foundation はフォールバックできずリソースを見つけられない可能性があるため、警告が出ます。
• 同じリソースに「ローカライズされていないバリアント」と「ローカライズされたバリアント」が同居している。Foundation の検索順序の都合で、この場合ローカライズ版が決して選ばれないため警告が出ます。

ランタイムでの利用

ビルド時には、各ローカライズリソースが Foundation の Bundle 検索パターンに合致する位置へ配置され、併せて CFBundleDevelopmentRegion に defaultLocalization を設定した Info.plist が生成されます。これによりランタイム側のコードは、通常のリソース読み込みと同じ API を使うだけで、適切にローカライズされた結果を得られます。

// 実行環境に応じたローカライズ版が自動的に選ばれる
let path = Bundle.module.path(forResource: "TOC", ofType: "md")
let image = UIImage(named: "Sign", in: .module, with: nil)

// strings ファイルからの取得も通常どおり
let localizedGreeting = NSLocalizedString("greeting", bundle: .module)