https://github.com/ferdzz/swiftlocalevalidator
A lightweight CLI utility to help Swift developers make sure that all the strings in NSLocalizedString are present in their locale and vice-versa
https://github.com/ferdzz/swiftlocalevalidator
hacktoberfest java localization-management localization-tool swift
Last synced: 6 months ago
JSON representation
A lightweight CLI utility to help Swift developers make sure that all the strings in NSLocalizedString are present in their locale and vice-versa
- Host: GitHub
- URL: https://github.com/ferdzz/swiftlocalevalidator
- Owner: Ferdzz
- Created: 2017-07-12T01:40:27.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-10-25T14:02:09.000Z (almost 4 years ago)
- Last Synced: 2025-02-11T15:59:55.843Z (8 months ago)
- Topics: hacktoberfest, java, localization-management, localization-tool, swift
- Language: Java
- Homepage:
- Size: 1.31 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Features
SwiftLocaleValidator will validate the localized strings in the following ways:
- Looks for strings that are defined multiple times in the Localizable.strings
- Looks for strings that are requested in the code using NSLocalizedString, but aren't found in the Localizable.strings
- Looks for strings that are defined in the Localizable.strings, but aren't requested in the code using NSLocalizedString
## How to use SwiftLocaleValidator
To use SwiftLocaleValidator, first grab the .jar file available [here](https://github.com/Ferdzz/SwiftLocaleValidator/blob/master/SwiftLocaleValidator.jar) and use the following CLI command to validate your strings. It's as simple as that.
```
java -jar SwiftLocaleValidator.jar -directory "path/to the project/directory" -locale "path/to/the/Localizable.strings"
```
Note that the lack of support of multiple locale files is intentional. All locale files should be validated one by one to ensure the best quality control possible.
If your project uses custom formats instead of `NSLocalizedString`, you can specify this using the `-substring` argument. For example, if your
project uses a pattern such as `"Localizable.Key".localized()`, you should specify the following:
```
java -jar SwiftLocaleValidator.jar -directory "path/to the project/directory" -locale "path/to/the/Localizable.strings" -substring "\"" "\".localized("
```
### Sample output:
```
Parsing the project...
--- Starting parsing locale file ---
'Label.DuplicatedKey' key was defined multiple times
--- Done parsing locale file ---
--- Parsing code for Localized String references ---
--- Done parsing code for Localized String references ---
--- Comparing code and locale file ---
'ErrorMessage.NoWifi.Title' was defined in the locale but not used in code!
'ErrorMessage.NoWifi.Message' was defined in the locale but not used in code!
------
'ErrorMessage.Unreachable.Title' was used in the code but never defined in the locale!
'ErrorMessage.Unreachable.Message' was used in the code but never defined in the locale!
--- Done comparing code and locale file, tasks finished ---
Done parsing the project!
```