https://github.com/dral3x/stringslint
📱Ensure your localized strings are complete and never unused 👍
https://github.com/dral3x/stringslint
command-line-tool ios macos swift xcode
Last synced: 3 months ago
JSON representation
📱Ensure your localized strings are complete and never unused 👍
- Host: GitHub
- URL: https://github.com/dral3x/stringslint
- Owner: dral3x
- License: mit
- Created: 2019-01-05T18:28:42.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-01T07:23:12.000Z (over 1 year ago)
- Last Synced: 2025-09-18T15:18:13.069Z (4 months ago)
- Topics: command-line-tool, ios, macos, swift, xcode
- Language: Swift
- Homepage:
- Size: 304 KB
- Stars: 70
- Watchers: 1
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# StringsLint
A tool to ensure localized strings are complete and never unused.
StringsLint hooks into your source files, specifically it scans:
- .`strings` and .`stringsdict`
- .`swift` and .`m`
- .`xib` and `.storyboard`
If you **found a bug** or **have a feature request**, please open an issue.
If you **want to contribute**, submit a pull request.
## Installation
### Using [Mint](https://github.com/yonaskolb/Mint):
```bash
mint install dral3x/stringslint
```
### Using [Homebrew](http://brew.sh/)
```bash
brew tap dral3x/dral3x
brew install stringslint
```
### Using [CocoaPods](https://cocoapods.org):
Simply add the following line to your Podfile:
```ruby
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.
### Compiling from source:
You can build from source by cloning this project and running `make install` (Xcode 10.0 or later).
## Usage
### Xcode
Integrate StringsLint into an Xcode scheme to get warnings and errors displayed
in the IDE. Just add a new "Run Script Phase" with:
```bash
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:
```bash
"${PODS_ROOT}/StringsLint/stringslint"
```
### Command Line
```
$ stringslint help
OVERVIEW: A tool to enforce Swift style and conventions.
USAGE: stringslint
OPTIONS:
--version Show the version.
-h, --help Show help information.
SUBCOMMANDS:
lint (default) Print lint warnings and errors (default command)
version Display the current version of StringsLint
See 'stringslint help ' for detailed help.
```
Run `stringslint` in the directory containing the files to lint.
Directories will be searched recursively.
### GitHub Action
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.1.9
```
More details here https://github.com/dral3x/action-stringslint
## Rules
There are few basic but important rules included.
See [Rules.md](Rules.md) for more information.
You can also check [Sources/StringsLintFramework/Rules/Lint](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.
### Configuration
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:
```yaml
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
swift_parser:
swiftui_implicit: false # disable implicit detection of SwiftUI localized strings
# 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
```
## License
[MIT licensed.](LICENSE)