Lint tool for your Localizable.strings
Lint based on your .l10nlint.yml:
l10nlint
When run with Xcode prebuild script, shows warning and errors.
duplicate_key Duplicated key should be resolved.
empty_key Empty localized key should be resolved.
empty_value Empty localized value should be resolved.
key_order Between Base and each language file's key should be same order.
mark_syntax Annotation should have around one space.
mixed_chinese The mixing of traditional and simplified chinese characters should be resolved.
multi_linefeed Linefeed should be one.
space_in_key Key should not have space.
todo TODOs and FIXMEs should be resolved.
This is useful feature!✨
Copy keys to each strings based on your .l10nlint.yml:
l10nlint copy [--delete-marker]
usage.mov
Define markers in your Base.lproj/Localizable.strings
Surround to copy content with // @copy and // @end keyword.
--delete-marker option is delete marker in your Base.lproj/Localizable.strings
If above line on your marker is comment, detect equality line, if above line on your marker is key, detect equality key.
// MARK: Main
"MainKey" = "Main value";
// @copy
"SecondGen1" = "Second gen value 1";
"SecondGen2" = "Second gen value 2";
// @end
brew install s2mr/tap/l10nlintAdd the following to the dependencies of your Package.swift:
dependencies: [
.package(url: "https://github.com/s2mr/L10nLint.git", from: "L10nLint version"),
]Run command:
swift run -c release l10nlint [COMMAND] [OPTIONS]Install with Mint by following command:
mint install s2mr/l10nlintRun command:
mint run s2mr/l10nlint [COMMAND] [OPTIONS]You can also install l10nlint by downloading l10nlint.zip from the latest GitHub release.
Place .l10nlint.yml file at your repository root.
base_path is directory path that is contains Localizable.strings
Example:
base_path: YourApp/Resources/
disabled_rules:
- empty_value
todo:
is_summary_enabled: true
summary_violation_limit: 20This command is built on swift-argument-parser.
Please refer to this article.
Replace example with l10nlint.
l10nlint --help
---
OVERVIEW: Lint tool for your Localizable.strings
USAGE: l10nlint [--config <config>] <subcommand>
OPTIONS:
--config <config> Custom config file path
--version Show the version.
-h, --help Show help information.
SUBCOMMANDS:
lint (default) Lint your Localizable.strings
rules Show all rules whether enabled or disabled
copy Copy keys your Base Localizable.strings
See 'l10nlint help <subcommand>' for detailed help.
l10nlint rules --help
---
OVERVIEW: Show all rules whether enabled or disabled
USAGE: l10nlint rules [--config <config>] [--print-parameters]
OPTIONS:
--config <config> Custom config file path
--print-parameters Show your rule's parameters in config
-h, --help Show help information.