73 lines
3.1 KiB
Swift
73 lines
3.1 KiB
Swift
//
|
|
// NestingRule.swift
|
|
// SwiftLint
|
|
//
|
|
// Created by JP Simard on 2015-05-16.
|
|
// Copyright (c) 2015 Realm. All rights reserved.
|
|
//
|
|
|
|
import SourceKittenFramework
|
|
|
|
public struct NestingRule: ASTRule, ConfigProviderRule {
|
|
|
|
public var config = SeverityConfig(.Warning)
|
|
|
|
public init() {}
|
|
|
|
public static let description = RuleDescription(
|
|
identifier: "nesting",
|
|
name: "Nesting",
|
|
description: "Types should be nested at most 1 level deep, " +
|
|
"and statements should be nested at most 5 levels deep.",
|
|
nonTriggeringExamples: ["class", "struct", "enum"].map { kind in
|
|
Trigger("\(kind) Class0 { \(kind) Class1 {} }\n")
|
|
} + [
|
|
Trigger("func func0() {\nfunc func1() {\nfunc func2() {\nfunc func3() {\n" +
|
|
"func func4() { func func5() {\n}\n}\n}\n}\n}\n}\n"),
|
|
Trigger("enum Enum0 { enum Enum1 { case Case } }")
|
|
],
|
|
triggeringExamples: ["class", "struct", "enum"].map { kind in
|
|
Trigger("\(kind) A { \(kind) B { ↓\(kind) C {} } }\n")
|
|
} + [
|
|
Trigger("func func0() {\nfunc func1() {\nfunc func2() {\nfunc func3() {\n" +
|
|
"func func4() { func func5() {\n↓func func6() {\n}\n}\n}\n}\n}\n}\n}\n")
|
|
]
|
|
)
|
|
|
|
public func validateFile(file: File, kind: SwiftDeclarationKind,
|
|
dictionary: [String: SourceKitRepresentable]) -> [StyleViolation] {
|
|
return validateFile(file, kind: kind, dictionary: dictionary, level: 0)
|
|
}
|
|
|
|
func validateFile(file: File, kind: SwiftDeclarationKind,
|
|
dictionary: [String: SourceKitRepresentable],
|
|
level: Int) -> [StyleViolation] {
|
|
var violations = [StyleViolation]()
|
|
let typeKinds: [SwiftDeclarationKind] = [.Class, .Struct, .Typealias, .Enum]
|
|
if let offset = (dictionary["key.offset"] as? Int64).flatMap({ Int($0) }) {
|
|
if level > 1 && typeKinds.contains(kind) {
|
|
violations.append(StyleViolation(ruleDescription: self.dynamicType.description,
|
|
severity: config.severity,
|
|
location: Location(file: file, byteOffset: offset),
|
|
reason: "Types should be nested at most 1 level deep"))
|
|
} else if level > 5 {
|
|
violations.append(StyleViolation(ruleDescription: self.dynamicType.description,
|
|
severity: config.severity,
|
|
location: Location(file: file, byteOffset: offset),
|
|
reason: "Statements should be nested at most 5 levels deep"))
|
|
}
|
|
}
|
|
let substructure = dictionary["key.substructure"] as? [SourceKitRepresentable] ?? []
|
|
violations.appendContentsOf(substructure.flatMap { subItem in
|
|
if let subDict = subItem as? [String: SourceKitRepresentable],
|
|
kind = (subDict["key.kind"] as? String).flatMap(SwiftDeclarationKind.init) {
|
|
return (kind, subDict)
|
|
}
|
|
return nil
|
|
}.flatMap { kind, subDict in
|
|
return self.validateFile(file, kind: kind, dictionary: subDict, level: level + 1)
|
|
})
|
|
return violations
|
|
}
|
|
}
|