Files
SwiftLint/Source/SwiftLintFramework/Rules/FileNameRule.swift
T
JP Simard 24ec44d288 Add file_name opt-in rule
validating that file names contain the name of a
type or extension declared in the file (if any).
2018-05-11 22:17:39 -07:00

48 lines
1.8 KiB
Swift

import Foundation
import SourceKittenFramework
private let typeAndExtensionKinds = SwiftDeclarationKind.typeKinds + [.extension, .protocol]
private extension Dictionary where Key: ExpressibleByStringLiteral {
func recursiveDeclaredTypeNames() -> [String] {
let subNames = substructure.flatMap { $0.recursiveDeclaredTypeNames() }
if let kind = kind.flatMap(SwiftDeclarationKind.init),
typeAndExtensionKinds.contains(kind), let name = name {
return [name] + subNames
}
return subNames
}
}
public struct FileNameRule: ConfigurationProviderRule, OptInRule {
public var configuration = FileNameConfiguration(severity: .warning, excluded: ["main.swift", "LinuxMain.swift"])
public init() {}
public static let description = RuleDescription(
identifier: "file_name",
name: "File Name",
description: "File name should match a type or extension declared in the file (if any).",
kind: .idiomatic
)
public func validate(file: File) -> [StyleViolation] {
guard let filePath = file.path,
case let fileName = filePath.bridge().lastPathComponent,
!configuration.excluded.contains(fileName) else {
return []
}
let typeInFileName = fileName.components(separatedBy: CharacterSet(charactersIn: "+.")).first ?? fileName
let allDeclaredTypeNames = file.structure.dictionary.recursiveDeclaredTypeNames()
guard !allDeclaredTypeNames.isEmpty, !allDeclaredTypeNames.contains(typeInFileName) else {
return []
}
return [StyleViolation(ruleDescription: type(of: self).description,
severity: configuration.severity.severity,
location: Location(file: filePath, line: 1))]
}
}