Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/konrad1977/loco
A linter for Swift Localizations
https://github.com/konrad1977/loco
cli linter localization-management static-code-analysis swift xcode
Last synced: 3 months ago
JSON representation
A linter for Swift Localizations
- Host: GitHub
- URL: https://github.com/konrad1977/loco
- Owner: konrad1977
- License: mit
- Created: 2022-07-16T13:27:12.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-27T15:06:28.000Z (12 months ago)
- Last Synced: 2024-07-19T03:49:25.206Z (4 months ago)
- Topics: cli, linter, localization-management, static-code-analysis, swift, xcode
- Language: Swift
- Homepage:
- Size: 3.06 MB
- Stars: 72
- Watchers: 6
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```shell
swift build -c release
```
##### Debug
```shell
swift build
```
Copy the loco binary from either .build/release or .build/debug to
```shell
/usr/local/bin
```
## How to use
### Integrate with Xcode
In build phases. Add run script (+)
```shell
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.
```shell
$ loco
```
#### Arguments
Lint individual swift files (check for missing translations only)
```shell
$ loco -f "/myProject/Sources/Subfolder/somefile.swift"
```
Enable colored output
```shell
$ loco --color
```
With color
Without color
