-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2672 from matthew-healy/matthew-healy/nslocalized…
…string-require-bundle Add NSLocalizedStringRequireBundleRule
- Loading branch information
Showing
7 changed files
with
140 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
Source/SwiftLintFramework/Rules/Lint/NSLocalizedStringRequireBundleRule.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| import SourceKittenFramework | ||
|
|
||
| public struct NSLocalizedStringRequireBundleRule: ASTRule, OptInRule, ConfigurationProviderRule, AutomaticTestableRule { | ||
| public var configuration = SeverityConfiguration(.warning) | ||
|
|
||
| public init() {} | ||
|
|
||
| public static let description = RuleDescription( | ||
| identifier: "nslocalizedstring_require_bundle", | ||
| name: "NSLocalizedString Require Bundle", | ||
| description: "Calls to NSLocalisedString should specify the bundle which contains the strings file.", | ||
| kind: .lint, | ||
| nonTriggeringExamples: [ | ||
| """ | ||
| NSLocalizedString("someKey", bundle: .main, comment: "test") | ||
| """, | ||
| """ | ||
| NSLocalizedString("someKey", tableName: "a", | ||
| bundle: Bundle(for: A.self), | ||
| comment: "test") | ||
| """, | ||
| """ | ||
| NSLocalizedString("someKey", tableName: "xyz", | ||
| bundle: someBundle, value: "test" | ||
| comment: "test") | ||
| """, | ||
| """ | ||
| arbitraryFunctionCall("something") | ||
| """ | ||
| ], | ||
| triggeringExamples: [ | ||
| """ | ||
| ↓NSLocalizedString("someKey", comment: "test") | ||
| """, | ||
| """ | ||
| ↓NSLocalizedString("someKey", tableName: "a", comment: "test") | ||
| """, | ||
| """ | ||
| ↓NSLocalizedString("someKey", tableName: "xyz", | ||
| value: "test", comment: "test") | ||
| """ | ||
| ] | ||
| ) | ||
|
|
||
| public func validate(file: File, | ||
| kind: SwiftExpressionKind, | ||
| dictionary: [String: SourceKitRepresentable]) -> [StyleViolation] { | ||
| let isBundleArgument: ([String: SourceKitRepresentable]) -> Bool = { $0.name == "bundle" } | ||
| guard kind == .call, | ||
| dictionary.name == "NSLocalizedString", | ||
| let offset = dictionary.offset, | ||
| !dictionary.enclosedArguments.contains(where: isBundleArgument) else { | ||
| return [] | ||
| } | ||
|
|
||
| return [ | ||
| StyleViolation(ruleDescription: type(of: self).description, | ||
| severity: configuration.severity, | ||
| location: Location(file: file, byteOffset: offset)) | ||
| ] | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters