{"id":48044536,"url":"https://github.com/nicorichard/xcstringslint","last_synced_at":"2026-04-04T14:16:51.942Z","repository":{"id":242721280,"uuid":"795121483","full_name":"nicorichard/xcstringslint","owner":"nicorichard","description":"Validate your String Catalogs. Release with confidence that your app is properly translated!","archived":false,"fork":false,"pushed_at":"2024-09-12T18:15:43.000Z","size":85,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-13T11:06:21.634Z","etag":null,"topics":["string-catalog","swift","xcstrings"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nicorichard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-02T16:17:14.000Z","updated_at":"2024-09-12T18:15:46.000Z","dependencies_parsed_at":"2024-06-23T21:28:56.509Z","dependency_job_id":"ae213d4a-8f00-499c-82e6-744aa35b6185","html_url":"https://github.com/nicorichard/xcstringslint","commit_stats":null,"previous_names":["nicorichard/xcstringslint"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/nicorichard/xcstringslint","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicorichard%2Fxcstringslint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicorichard%2Fxcstringslint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicorichard%2Fxcstringslint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicorichard%2Fxcstringslint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nicorichard","download_url":"https://codeload.github.com/nicorichard/xcstringslint/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicorichard%2Fxcstringslint/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31402278,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T10:20:44.708Z","status":"ssl_error","status_checked_at":"2026-04-04T10:20:06.846Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["string-catalog","swift","xcstrings"],"created_at":"2026-04-04T14:16:51.832Z","updated_at":"2026-04-04T14:16:51.920Z","avatar_url":"https://github.com/nicorichard.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# xcstringslint\n\nSetup deterministic validation of your app's `.xcstrings` [string catalogs](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog).\n\nEnsure your string catalog changes are always up-to-snuff with your team's localization requirements.\n\n## Usage\n\n### Running\n#### CLI\n\nWith a [config file](.xcstringslint.yaml) located in the same directory as the executable\n\n```bash\nswift run xcstringslint Sources/StringCatalogValidator/Resources/Localizable.xcstrings\n```\n\nTo specify a config file append `--config [config file path]`\n\n#### GitHub Actions\n\nSee [this repository's actions for an example](.github/workflows/lint.yaml)\n\n#### Plugin\n\nThe [XCStringsLintPlugin](https://github.com/nicorichard/XCStringsLintPlugin) repository is maintained separately.\n\n### Configuration\n\n#### Rules\n\n##### `require-locale`\n\nEnsures that for each locale has a translation present in the `.xcstrings` file.\n\ne.g. ensure that each key has a translation for `en` and `fr`\n```yaml\nrules:\n    require-locale:\n        values:\n            - en\n            - fr\n```\n\n##### `require-localization-state`\n\nEnsures that each key has a localization state matching the provided values.\n\ne.g. ensure that each key has a localization state of `translated`\n```yaml\nrules:\n    require-localization-state:\n        value: translated\n```\n\nTo negate this rule use `reject-localization-state` instead.\n\n##### `require-extraction-state`\n\nEnsures that each key has a translation for each extraction state.\n\ne.g. ensure that each key was automatically extracted\n```yaml\nrules:\n    require-extraction-state:\n        value: \"automatic\"\n```\n\nTo negate this rule use `reject-extraction-state` instead.\n\n#### Ignoring Keys\n\nTo ignore all validation for a particular key, either mark them as \"Don't Translate\" or include `[no-lint]` in the key's comment.\n\nTo ignore a specific rule, include `[no-lint:rule-name]` in the key's comment, e.g. `[no-lint:require-locale]`\n\n## Example Output\n\n```\n$ swift run xcstringslint Sources/StringCatalogValidator/Resources/Localizable.xcstrings\n\n`Rejects an entry if its extraction state matches any of the provided values. Known extractions states:  %@`:\n  ⚠️ require-localization-state: no translation state found\n  ⚠️ require-locale: missing translation for 1 locale: en\n`Rejects an entry if its extraction state matchs any of the provided values. Known extractions states:  %@`:\n  ⚠️ require-extraction-state: should not have extraction state `stale`\n`found state `%@`, expected %@`:\n  ⚠️ require-extraction-state: should not have extraction state `stale`\n`found state `%@`, expected `%@``:\n  ⚠️ require-localization-state: found state `new`, expected `translated`\n`found state `%@`, expected one of %@`:\n  ⚠️ require-extraction-state: should not have extraction state `stale`\n`found state `%@`, expected one of: %@`:\n  ⚠️ require-localization-state: found state `new`, expected `translated`\n\n[Warning]: Found 7 total issues in 6 keys\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicorichard%2Fxcstringslint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnicorichard%2Fxcstringslint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicorichard%2Fxcstringslint/lists"}