Files
SwiftLint/Source/SwiftLintFramework/Rules/DiscouragedOptionalBooleanRule.swift
T
JP Simard b83e0991b9 Remove all file headers
The MIT license doesn't require that all files be prepended with this
licensing or copyright information. Realm confirmed that they're ok with this
change. This will enable some companies to contribute to SwiftLint and the
date & authorship information will remain accessible via git source control.
2018-05-04 13:42:02 -07:00

31 lines
1.3 KiB
Swift

import Foundation
import SourceKittenFramework
public struct DiscouragedOptionalBooleanRule: OptInRule, ConfigurationProviderRule {
public var configuration = SeverityConfiguration(.warning)
public init() {}
public static let description = RuleDescription(
identifier: "discouraged_optional_boolean",
name: "Discouraged Optional Boolean",
description: "Prefer non-optional booleans over optional booleans.",
kind: .idiomatic,
nonTriggeringExamples: DiscouragedOptionalBooleanRuleExamples.nonTriggeringExamples,
triggeringExamples: DiscouragedOptionalBooleanRuleExamples.triggeringExamples
)
public func validate(file: File) -> [StyleViolation] {
let booleanPattern = "Bool\\?"
let optionalPattern = "Optional\\.some\\(\\s*(true|false)\\s*\\)"
let pattern = "(" + [booleanPattern, optionalPattern].joined(separator: "|") + ")"
let excludingKinds = SyntaxKind.commentAndStringKinds
return file.match(pattern: pattern, excludingSyntaxKinds: excludingKinds).map {
StyleViolation(ruleDescription: type(of: self).description,
severity: configuration.severity,
location: Location(file: file, characterOffset: $0.location))
}
}
}