Swiftpack.co - AckeeCZ/ACKLocalization as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by AckeeCZ.
AckeeCZ/ACKLocalization 1.5.0
Localize your Cocoa apps from Google Spreadsheet
⭐️ 20
🕓 8 weeks ago
macOS
.package(url: "https://github.com/AckeeCZ/ACKLocalization.git", from: "1.5.0")

Tests Version License

ACKLocalization

Simply localize your app with translations stored in Google Spreadsheet.

Installation

Cocoapods

  1. Add ACKLocalization to your Podfile
pod 'ACKLocalization`
  1. Install pods
pod install

Manually

Just download binary from Github release

Usage

You can use ACKLocalization in two ways:

  1. safer and recommended use with Service Account
  2. use with API key

Use with Service Account

This method is safe in the way that you can fully control who has access to your spreadsheet. You create a service account, invite it as viewer to your spreadsheet and you're ready to go.

Create a Service Account

You need to have a Google project in Google Dev console, there you go to Credentials ➡️ create credentials ➡️ service account key. Then you need to enable Google Sheets API in the console.

Invite Service Account to your spreadsheet

The Service Account has associated email address, you need to invited that address to your spreadsheet, so it is available to read the document.

Now you can skip to getting your spreadsheet identifier

Use with API key

You need to have a Google project in Google Dev console, there you go to Credentials ➡️ create credentials ➡️ API Key. This will create unrestricted API key, we recommend to restrict it as much as possible - application restrictions are unluckily not possible to use - maybe if you intend to run the script on CI, then you can restrict it to certain IPs. What you can do is to restrict the API key to Google Sheets API (you might need to enable this API first in the console).

Get your Google Spreadsheet identifier

You get the spreadsheet identifier from its URL:

https://docs.google.com/spreadsheets/d/<YOUR_SPREADSHEET_ID>/edit#gid=0

Now you can build your configuration file

The file is named localization.json. This is how example file looks like, you can find the Swift representation here:

{
    "defaultFileName": "Localizable",
    "destinations": {
        "Localizable": "Framework/Resources",
        "InfoPlist": "App/Resources"
    },
    "keyColumnName": "iOS",
    "languageMapping": {
        "CZ": "cs"
    },
    "serviceAccount": "Resources/ServiceAccount.json",
    "spreadsheetID": "<GOOGLE_SPREADSHEET_ID>",
}

Attributes documentation:

Name Required Note
defaultFileName ✅ Name of default strings(dict) file
destinations ✅ Dictionary of destinations for all generated files (at least entry with defaultFileName is required), if you use plist.<filename>. prefix in your sheet, you might wanna add those entries as well, otherwise they will be generated alongside the default file
keyColumnName ✅ Name of column that contains keys to be localized
languageMapping ✅ Mapping of language column names to app languages, you specify how columns in spreasheet should be mapped to app languages
apiKey ❌ API key that will be used to communicate with Google Sheets API, apiKey or serviceAccount has to be provided
serviceAccount ❌ Path to service account file that will be used to access spreadsheet, apiKey or serviceAccount has to be provided
spreadsheetID ✅ Identifier of spreadsheet that should be downloaded
spreadsheetTabName ❌ Name of spreadsheet tab to be fetched, if nothing is specified, we will use the first tab in spreadsheet

The file has to be in the same directory where you call ACKLocalization.

To be able to communicate with Google Sheets API, you need to provide either apiKey or serviceAccount parameter or use environment variable. If both are provided, then serviceAccount will be used.

Environment variables

Do you want to share secrets across multiple projects, or do you not want to keep secrets in the project repository? We have the solution for you. Just set one of the environment variables below.

ACKLOCALIZATION_SERVICE_ACCOUNT_PATH - Path to service account file that will be used to access spreadsheet ACKLOCALIZATION_API_KEY - API key that will be used to communicate with Google Sheets API

apiKey or serviceAccount defined in localization.json have higher priority than environment values. If both are provided then ACKLOCALIZATION_SERVICE_ACCOUNT_PATH will be used.

Calling ACKLocalization

Just call the binary, remember that the configuration file has to be in the same directory where you call ACKLocalization.

Pods/ACKLocalization/Localization

Example

We love to call ACKLocalization from Xcode (we have a separate aggregate target which calls the script) so I'll stick with that with this example.

Project structure

This is example folder structure of the project

|-localization.json
|-Podfile
|-Project.xcodeproj
|-ServiceAccount.json
|-App
|---Resources
|------en.lproj
|----------InfoPlist.strings
|------cs.lproj
|----------InfoPlist.strings
|-Framework
|---Resources
|------en.lproj
|----------Localizable.strings
|----------Localizable.stringsDict
|------cs.lproj
|----------Localizable.strings
|----------Localizable.stringsDict

Spreadsheet structure

This is example structure of the spreadsheet with translations

key_ios EN CS
hello Hello Ahoj
plist.InfoPlist.NSCameraUsageDescription Cammera usage description Popis využití kamery

Example config file for this case would be

This is the example config file:

{
    "defaultFileName": "Localizable",
    "destinations": {
        "Localizable": "Framework/Resources",
        "InfoPlist": "App/Resources"
    },
    "keyColumnName": "key_ios",
    "languageMapping": {
        "CS": "cs",
        "EN": "en"
    },
    "serviceAccount": "Resources/ServiceAccount.json",
    "spreadsheetID": "<GOOGLE_SPREADSHEET_ID>",
    "spreadsheetTabName": "Localizations"
}

Plist keys

ACKLocalization supports localizing plist files. Simply prefix the key with plist.InfoPlist, where InfoPlist is the name of plist you need to localize and ACKLocalization will automatically generate respective InfoPlist.strings files. Please note that InfoPlist name is case-sensitive.

Example keys:

plist.InfoPlist.NSPhotoLibraryAddUsageDescription
plist.InfoPlist.NSUserTrackingUsageDescription

InfoPlist.strings result:

"NSPhotoLibraryAddUsageDescription" = "Your photo library usage message.";
"NSUserTrackingUsageDescription" = "Your tracking permission message.";

Plural keys

To add plurals to the spreadsheet, you need to specify the translation key and the plural type using the following native convention:

translation.key##{zero}
translation.key##{one}
translation.key##{two}
translation.key##{few}
translation.key##{many}
translation.key##{other}

This will be automatically generated into Localizable.stringsDict and the key won't be presented in Localizable.strings.

Example:

ackee|ACKLocalization

Author

Ackee team

License

ACKLocalization is available under the MIT license. See the LICENSE file for more info.

GitHub

link
Stars: 20
Last commit: 4 days ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Release Notes

8 weeks ago

Added

  • Add support to define destination for all files that are generated (#34, kudos to @olejnjak)
  • Generate localizations even for items that have empty value (#34, kudos to @olejnjak)

Changed

  • BREAKING: Configuration field stringsDictFileName has no more effect, from now on stringsdicts are generated alongside corresponding stringsfile (#34, kudos to @olejnjak)

Compilation requires Xcode 14 (running through mint also as it is compiled first)

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics