Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 3.47 KB

README.md

File metadata and controls

66 lines (44 loc) · 3.47 KB
Raw

XCStrings Tool

Tests

A plugin to generate Swift constants for your String Catalogs and other localized string resources on Apple platforms.

Motivation

Hardcoding localized strings in your code and then having the compiler automatically extract them into the Strings Catalog (or legacy .strings files) works great on smaller projects, but over time you will often find that this approach doesn't scale well.

You usually find yourself compromising on either code quality, translator comments or boilerplate code from having to define your own constants, but it doesn't have to be this way!

struct ContentView: View {
    @Query var items: [Item]

    var body: some View {
        List {
            Section {
                ForEach(items) { item in
                    ItemView(item)
                }
            } footer: {
                Text(.localizable(.footerText(items.count)))
            }
        }
        .navigationTitle(.localizable(.contentViewTitle))
    }
}

XCStrings Tool aims to extend your localization experience so that you don't have to compromise anything. It does this by using your Strings Catalog as a source for generating elegant Swift code that you can reference directly within the rest of your project.

Requirements

  • An Xcode or Swift Package project using Xcode 15 or later.
  • Localizations using the new Strings Catalogs (.xcstrings) or legacy .strings and .stringsdict formats.

Getting Started

XCStrings Tool is a Swift Package Plugin that can integrate directly into Xcode and Swift Package targets that contain Strings Catalog (.xcstrings) files.

For more information about the Strings Catalog format, check out the Discover Strings Catalogs video from WWDC 2023.

Demo

To see XCStrings Tool in action, check out the Dog Tracker demo project for yourself.

Documentation

View the documentation on the Swift Package Index

If you have an improvement for the documentation, you can modify it here.

Contributing

Contributions to XCStrings Tool are welcome!