konrad1977 / loco

A linter for Swift Localizations

Loco

Loco is an extremly fast CLI linter for Localization.strings and swift files.

What does it check?

• Semicolons

• Untranslated strings in your swift files

• Empty values

• Duplicate keys

• Unused keys

• Missing keys in one or more languages

• Missing a translation file for a whole language

• Works with swiftgen generated localizations.

New features:

• Doesnt lint empty strings inside normally checked objects.
• It doesnt check commented out strings that normally would be checked (Single line comments.)

Output format

• Loco will output its result in a compiler error log format so it can easily be integrated in third party apps (like Xcode, Emacs, Vim)

Limitation

• Loco builds two separate sets of data for each source file, one is for known localization pattern, such as NSLocalizedString, etc. The other one is for all the strings. Loco will then check if any of those are in a .strings file for silent warnings about unused translation keys. But it wont discover if a such key is untranslated.
• Does not lint Localization.dict
• Does not lint Storyboards
• Will have false positive / true negatives
• Needs a bit code clean up. (imperative coding mixed with tons of functional. Sorry purists)
• Only some unit tests (more will come)

Installation

Compile the project using terminal (or Xcode)

Release

swift build -c release

Debug

swift build

Copy the loco binary from either .build/release or .build/debug to

/usr/local/bin

How to use

Integrate with Xcode

In build phases. Add run script (+)

if which loco > /dev/null; then
	loco
else 
	echo "warning: Loco is not installed. Compile from https://github.com/konrad1977/loco"
fi

Make sure you run loco before compile sources to get info where you are missing a semicolon

From terminal

Just run loco from your project root.

$ loco

Arguments

Lint individual swift files (check for missing translations only)

$ loco -f "/myProject/Sources/Subfolder/somefile.swift"

Enable colored output

$ loco --color

With color

Without color

loco's Issues

Swift/UnsafeBufferPointer.swift:898: Fatal error

Hi bro I just clone and use this one and it crash with this error, can you help me to check this

Custom Localised Strings pattern

Hi @konrad1977
Creating a separate issue

I did update to the latest version. It doesn't coght all the strings for me.
I was able to fix this by altering the RegexPattern file like this:

   static var sourceRegex: String {
        buildSourceRegex(
          [
            "\\.navigationTitle",
            "Label",
            "DatePicker",
            "Text",
            "Picker",
            "Button",
            "Toggle",
            "LocalizedStringKey",
            "NSLocalizedString",
            "String\\(localized:",
            "MyLocalizedString\\(",
          ]
        )
    }

also, I was trying to add a reg exps but failed for now for such cases:
let arrayOfLocalizedKeys = ["key_1", "key_2"];
let key = resourceAvailable ? "key_1" : "key_2";
enum States: String {
case online = "online_key"
case offline = "ofline_key"
}

or maybe there is a way to suppress individual strings.

Compatibility with SwiftGen localized enums

When using Loco on a project that has SwiftGen's generated enums, Loco shows warnings that the localized keys are unused.

Feature Request:

it would be great if Loco could also detect, in addition to NSLocalizedString, SwiftGen's L10n enum generated from the strings file.

https://github.com/SwiftGen/SwiftGen#strings

Add Homebrew Support

Is there any possibility to add Homebrew support for this for installation?

Never done it before but seem to be instructions here https://docs.brew.sh/Adding-Software-to-Homebrew

Might also need some version tags.

Keys are being used by still show that keys are unused

I run loco on my project it shows that the key no_data_empty is unused but I search again in project and that key are being used. Do I use your localization format correctly or this is a bug?