Rumpelstiltskin

Abstract

Rumpelstiltskin will turn your localization file looking like this:

"Accessibility.Example1" = "Accessibility";
"Accessibility.ThumbnailImage" = "Thumbnail %d with name %@";

into a swift struct looking like this:

struct Localizations {
    struct Accessibility {

        /// Base translation: Accessibility
        public static let Example1 = NSLocalizedString("Accessibility.Example1", tableName: nil, bundle: Bundle.main, value: "", comment: "")

        /// Base translation: Thumbnail %d with name %@
        public static func ThumbnailImage(value1: Int, _ value2: String) -> String {
            return String(format: NSLocalizedString("Accessibility.ThumbnailImage", tableName: nil, bundle: Bundle.main, value: "", comment: "")
            , value1, value2)
        }
    }
}

It is built to be a drop in replacement for the Laurine - Storyboard Generator Script which unfortunately stopped being maintained in 2017.

Requirements

• Swift 5.* (5.5 for SPM)

Currently not supported

• Multiline strings: Please use \n to format your strings within your Localizable.strings file

Installation

You can install the library via SPM or Cocoapods.

☝️ Note: It is highly recommended to use the Swift Build Plugin version as there is no guarantee for future Cocoapod compatibility.

Swift Package Manager (SPM)

Use the following link to add Rumpelstilskin as a Package Dependency to an Xcode project:

https://github.com/kurzdigital/Rumpelstiltskin.git

Cocoapods

Rumpelstiltskin is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'Rumpelstiltskin'

Configuration

Swift Build Tool Plugin

Rumpelstiltskin can be easily used as a build tool plugin inside XCode.

Build tool plugins run as a build phase of each target. When a project has multiple targets, the plugin must be added to the desired targets individually.

To do this, add the RumpelstiltskinBuildToolPlugin to the Run Build Tool Plug-ins phase of the Build Phases.

Cocoapods

Create a new run script phase whithin your Xcode project build phases.

echo "Rumpelstiltskin begins to dance around fire"
# Get base path to project
BASE_PATH="$PROJECT_DIR/$PROJECT_NAME"

# Get path to Generator script
GENERATOR_PATH="${PODS_ROOT}/Rumpelstiltskin/main.swift"

# Get path to main localization file (usually english).
SOURCE_PATH="$BASE_PATH/Supporting Files/Base.lproj/Localizable.strings"

OUTPUT_PATH="$BASE_PATH/Utils/Localizations.swift"

# Add permission to generator for script execution
chmod 755 "$GENERATOR_PATH"

# Will only re-generate script if something changed
if [ ! -f "$OUTPUT_PATH" ] || [ "$SOURCE_PATH" -nt "$OUTPUT_PATH" ]; then
    # Create the Localizations.swift-file if it doesn't exist yet
    if [ ! -f "$OUTPUT_PATH" ]; then
        touch "$OUTPUT_PATH"
    fi
    "$GENERATOR_PATH" "$SOURCE_PATH" "$OUTPUT_PATH"
    echo "Regenerated strings structure"
fi

You may have to change SOURCE_PATH and OUTPUT_PATH to your needs.

If you run Rumpelstiltskin for the first time you will have to add the newly generated Localizations.swift to your project. From then on the file will be updated automatically whenever the Localizable.strings file is changed.

Usage

We assume that you already have a Localizable.strings file in place.

Generate nested structures by seperating them with a .

# Localizable.strings
"MainStructure.NestedStructure.ConcreteValue" = "This needs to be localized";

// Code
label.text = Localizations.MainStructure.NestedStructure.ConcreteValue

Use functions to build strings. (Currently supported are Int, Float and String)

// %@: String, %d: Int, %f: float
"Buttons.TextWithVariables" = "Awesome %@, press me %d times!";

// Code
label.text = Localizations.Buttons.TextWithVariables(value1: "App", value2: 10)

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Author

KURZ Digital Solutions GmbH & Co. KG

License

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