mirror of
https://github.com/realm/SwiftLint.git
synced 2026-06-06 20:18:40 +00:00
Zev Eisenberg
fcf848608e
* Add Example wrapper in order to display test failures inline when running in Xcode. * Stop using Swift 5.1-only features so we can compile on Xcode 10.2. * Wrap strings in Example. * Add Changelog entry. * Wrap all examples in Example struct. * Better and more complete capturing of line numbers. * Fix broken test. * Better test traceability. * Address or disable linting warnings. * Add documentation comments. * Disable linter for a few cases. * Limit mutability and add copy-and-mutate utility functions. * Limit scope of mutability.
43 lines
1.7 KiB
Swift
43 lines
1.7 KiB
Swift
import SourceKittenFramework
|
|
|
|
public struct NSLocalizedStringKeyRule: ASTRule, OptInRule, ConfigurationProviderRule, AutomaticTestableRule {
|
|
public var configuration = SeverityConfiguration(.warning)
|
|
|
|
public init() {}
|
|
|
|
public static let description = RuleDescription(
|
|
identifier: "nslocalizedstring_key",
|
|
name: "NSLocalizedString Key",
|
|
description: "Static strings should be used as key in NSLocalizedString in order to genstrings work.",
|
|
kind: .lint,
|
|
nonTriggeringExamples: [
|
|
Example("NSLocalizedString(\"key\", comment: nil)"),
|
|
Example("NSLocalizedString(\"key\" + \"2\", comment: nil)")
|
|
],
|
|
triggeringExamples: [
|
|
Example("NSLocalizedString(↓method(), comment: nil)"),
|
|
Example("NSLocalizedString(↓\"key_\\(param)\", comment: nil)")
|
|
]
|
|
)
|
|
|
|
public func validate(file: SwiftLintFile,
|
|
kind: SwiftExpressionKind,
|
|
dictionary: SourceKittenDictionary) -> [StyleViolation] {
|
|
guard kind == .call,
|
|
dictionary.name == "NSLocalizedString",
|
|
let firstArgument = dictionary.enclosedArguments.first,
|
|
firstArgument.name == nil,
|
|
let byteRange = firstArgument.byteRange,
|
|
case let kinds = file.syntaxMap.kinds(inByteRange: byteRange),
|
|
!kinds.allSatisfy({ $0 == .string }) else {
|
|
return []
|
|
}
|
|
|
|
return [
|
|
StyleViolation(ruleDescription: type(of: self).description,
|
|
severity: configuration.severity,
|
|
location: Location(file: file, byteOffset: byteRange.location))
|
|
]
|
|
}
|
|
}
|