Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liamnichols/xcstrings-tool
A plugin to generate Swift constants for your Strings Catalogs.
https://github.com/liamnichols/xcstrings-tool
i18n localization swift xcode xcstrings
Last synced: 10 days ago
JSON representation
A plugin to generate Swift constants for your Strings Catalogs.
- Host: GitHub
- URL: https://github.com/liamnichols/xcstrings-tool
- Owner: liamnichols
- License: mit
- Created: 2023-09-23T20:44:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-13T15:15:21.000Z (29 days ago)
- Last Synced: 2024-10-14T14:59:45.368Z (28 days ago)
- Topics: i18n, localization, swift, xcode, xcstrings
- Language: Swift
- Homepage: https://swiftpackageindex.com/liamnichols/xcstrings-tool/documentation/documentation
- Size: 14.3 MB
- Stars: 180
- Watchers: 3
- Forks: 27
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# XCStrings Tool
[](https://github.com/liamnichols/xcstrings-tool/actions/workflows/tests.yml)
[](https://swiftpackageindex.com/liamnichols/xcstrings-tool)
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!
```swift
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.
- [**Integrating XCStrings Tool into an Xcode Project Target**](https://swiftpackageindex.com/liamnichols/xcstrings-tool/documentation/documentation/integrating-xcstrings-tool-into-an-xcode-project-target)
- [**Integrating XCStrings Tool into a Swift Package Target**](https://swiftpackageindex.com/liamnichols/xcstrings-tool/documentation/documentation/integrating-xcstrings-tool-into-a-swift-package-target)
- [**Using the generated source code**](https://swiftpackageindex.com/liamnichols/xcstrings-tool/documentation/documentation/using-the-generated-source-code)
For more information about the Strings Catalog format, check out the [Discover Strings Catalogs](https://developer.apple.com/videos/play/wwdc2023/10155/) video from WWDC 2023.
## Demo
To see XCStrings Tool in action, check out the [Dog Tracker demo project](https://github.com/liamnichols/xcstrings-tool-demo) for yourself.
## Documentation
[**View the documentation on the Swift Package Index**](https://swiftpackageindex.com/liamnichols/xcstrings-tool/documentation/documentation)
If you have an improvement for the documentation, you can [modify it here](./Sources/Documentation/XCStringsToolPlugin.docc).
## Contributing
Contributions to XCStrings Tool are welcome!
- For ideas and questions: [Visit the Discussions](https://github.com/liamnichols/xcstrings-tool/discussions)
- For bugs: [Open an Issue](https://github.com/liamnichols/xcstrings-tool/issues/choose)
- For contributions: [Open a Pull Request](https://github.com/liamnichols/xcstrings-tool/compare)