kayak / swiftgenstrings

genstrings replacement for Swift that actually works

SwiftGenStrings

SwiftGenStrings is a command line application that can be used as a drop-in replacement for the standard genstrings command for Swift sources. The latter only supports the short form of the NSLocalizedString function but breaks as soon as you use any parameters other than key and comment as in

NSLocalizedString("DATE_RANGE", value: "%@ – %@", comment: "A range of dates")

The upstream issue is tracked here.

Usage

USAGE: SwiftGenStrings <files> ... [-s <s>] [-o <o>] [--exclude-comments]

ARGUMENTS:
  <files>                 List of files, that are used as source of
                          Localizable.strings generation.

OPTIONS:
  -s <s>                  (Optional) Substitute for NSLocalizedString, useful when different macro is used.
  -o <o>                  (Optional) Specifies what directory Localizable.strings table is created in. Not specifying output directory will print script output
                          content to standard output (console).
  -e, --exclude-comments  (Optional) Formatted output does not include comments
  --version               Show the version.
  -h, --help              Show help information.

To gather strings in current directory, run:

$ find . -name "*.swift" | xargs SwiftGenStrings

If you have any 3rd party code like CocoaPods or Carthage in your project directory, you might want to exclude it from localization. To do that, run the following:

$ find . \( -name "*.swift" ! -path "./Carthage/*" ! -path "./Pods/*" \) | xargs SwiftGenStrings

Installation

Mint

The quickest and easiest way to install SwiftGenStrings is via Mint

$ mint install kayak/SwiftGenStrings

Prebuilt Binaries

We tag releases and upload prebuilt binaries to GitHub. Checkout the releases tab or go straight to the latest release.

From Git

The project provides a Makefile. To export a binary run:

$ make release

The exported binary can be found under Products/SwiftGenStrings. Alternatively you can use make install to install the compiled library directly into /usr/local/bin/SwiftGenStrings

Testing

Since SwiftGenStrings is a SPM package, running tests is easy:

$ swift test

Requirements

• Xcode 12
• Swift 5.3

Limitations

• SwiftGenStrings currently doesn't support multiple tables, only the default one - Localizable.strings.
• It is not possible to use NSLocalizedString in string interpolation e.g.: let hello = "--- \(NSLocalizedString("Hello world!", comment: ""))" will not pickup the localized string.

swiftgenstrings's Issues

distribution through brew / swift package manager / cocoapods

Currently consumers of this project need to clone and build it locally. If this was distributed through a package manager it would make adding this to projects locally a bit easier.

Thanks for open sourcing this project.

Fatal error

find . -name "*.swift" | xargs SwiftGenStrings

Fatal error: 'try!' expression unexpectedly raised an error: Error Domain=NSCocoaErrorDomain Code=260 "The file “Supporting” couldn’t be opened because there is no such file." UserInfo={NSFilePath=./Pods/Log/Source/Supporting, NSUnderlyingError=0x7fd7c5007b80 {Error Domain=NSPOSIXErrorDomain Code=2 "No such file or directory"}}: file /BuildRoot/Library/Caches/com.apple.xbs/Sources/swiftlang/swiftlang-902.0.48/src/swift/stdlib/public/core/ErrorType.swift, line 184

Feature request - change output format

For example in many cases you need just a list of "some_value" = "some_value"; - without of comments. Why not to add it?

Support String extension for localization

Hi,

I defined this extension for localizing strings, How can I get strings file?

extension String {
    func localized(_ args: CVarArg..., comment: String = "") -> String {
        if args.isEmpty {
            return NSLocalizedString(self, comment: comment)
        } else {
            let format = NSLocalizedString(self, comment: comment)
            return String(format: format, arguments: args)
        }
    }
}

"Hello world!".localized()
let name = "Amir"
"Hello %@".localized(name, comment: "Say hello")

Add ability to parse LocalizedStringKey

The tool should be able to parse LocalizedStringKey, which is used for SwiftUI localisation.
We could either do this with a flag for example (whether you want to parse it as well or not)

SwiftGenStrings not found

installed via mint