A tool to ensure localized strings are complete and never unused.
StringsLint hooks into your source files, specifically it scans:
- .
stringsand .stringsdict - .
swiftand .m - .
xiband.storyboard
If you found a bug or have a feature request, please open an issue. If you want to contribute, submit a pull request.
Using Mint:
mint install dral3x/stringslintUsing Homebrew
brew tap dral3x/dral3x
brew install stringslintUsing CocoaPods:
Simply add the following line to your Podfile:
pod 'StringsLint'This will download the StringsLint binaries and dependencies in Pods/ during your next
pod install execution and will allow you to invoke it via ${PODS_ROOT}/StringsLint/stringslint
in your Script Build Phases.
This is the recommended way to install a specific version of StringsLint since it supports installing a pinned version rather than simply the latest (which is the case with Homebrew and Mint).
Note that this will add the StringsLint binaries, its dependencies' binaries and the Swift binary
library distribution to the Pods/ directory, so checking in this directory to SCM such as
git is discouraged.
You can build from source by cloning this project and running make install (Xcode 10.0 or later).
Integrate StringsLint into an Xcode scheme to get warnings and errors displayed in the IDE. Just add a new "Run Script Phase" with:
if which stringslint >/dev/null; then
stringslint
else
echo "warning: StringsLint not installed, download from https://github.com/dral3x/StringsLint"
fi
Alternatively, if you've installed StringsLint via CocoaPods the script should look like this:
"${PODS_ROOT}/StringsLint/stringslint"$ stringslint help
Available commands:
help Display general or command-specific help
lint Print lint warnings and errors (default command)
version Display the current version of StringsLint
Run stringslint in the directory containing the files to lint.
Directories will be searched recursively.
Create a new workflow file in your repo (for example: .github/workflows/stringslint.yml) with the following content:
name: StringsLint
on:
pull_request:
paths:
- '.github/workflows/stringslint.yml'
- '.stringslint.yml'
- '**/*.swift'
- '**/*.strings'
- '**/*.stringsdict'
jobs:
StringsLint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: GitHub Action for StringsLint
uses: dral3x/action-stringslint@1.0.1
More details here https://github.com/dral3x/action-stringslint
There are few basic but important rules included. See Rules.md for more information.
You can also check Sources/StringsLintFramework/Rules/Lint directory to see their implementation.
Each rule can emit violations. You can configure the severity of these violations (accepted values are none, warning and error).
When a violation with severity error is emitted, the Xcode build will fail.
Configure StringsLint by adding a .stringslint.yml file from the directory you'll run StringsLint from.
You can configure included and excluded file paths, extends some parsers capabilities and even turn off rules or specific files for each rule:
included: # paths to include during linting. `--path` is ignored if present.
- Source
excluded: # paths to ignore during linting. Takes precedence over `included`.
- Carthage
- Pods
- Source/ExcludedFolder
- Source/ExcludedFile.swift
- Source/*/ExcludedFile.swift # Exclude files with a wildcard
# Customize parsers
objc_parser:
implicit_macros:
- SPKLocalizedString # detect this custom macro
xib_parser:
key_paths:
- textLocalized # keyPath used to localized UI elements
# Customize specific rules
missing:
severity: error
ignored:
- Demo title
partial:
severity: warning
unused:
severity: note
ignored:
- NSAppleMusicUsageDescription # used by iOS directly
missing_comment:
severity: none