Files
SwiftLint/Source/SwiftLintFramework/Rules/Lint/NSLocalizedStringKeyRule.swift
T
JP Simard fe5baca7cd Migrate to use SourceKitten's new ByteCount/ByteRange types (#3037)
New APIs were introduced in SourceKitten to allow for a more typesafe distinction between integers meaning NSString-based distances and byte-based distances.

* https://github.com/jpsim/SourceKitten/pull/639
* https://github.com/jpsim/SourceKitten/pull/642

This PR migrates SwiftLint's use of those APIs.
2020-01-16 15:18:37 -08:00

43 lines
1.6 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: [
"NSLocalizedString(\"key\", comment: nil)",
"NSLocalizedString(\"key\" + \"2\", comment: nil)"
],
triggeringExamples: [
"NSLocalizedString(↓method(), comment: nil)",
"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))
]
}
}