GitHub/SwiftLint
1
0
Fork 0
mirror of https://github.com/realm/SwiftLint.git synced 2026-06-06 20:18:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix some false positives in detecting for initializers

Browse Source 
in function_parameter_count
This commit is contained in:
JP Simard
2016-12-07 16:24:54 -08:00
parent 427a0c3b6f
commit f0804fa51c
1 changed files with 18 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Source/SwiftLintFramework/Rules/FunctionParameterCountRule.swift
+18 -11
View File
@@ -20,6 +20,7 @@ public struct FunctionParameterCountRule: ASTRule, ConfigurationProviderRule {
description: "Number of function parameters should be low.",
nonTriggeringExamples: [
"init(a: Int, b: Int, c: Int, d: Int, e: Int, f: Int) {}",
"init (a: Int, b: Int, c: Int, d: Int, e: Int, f: Int) {}",
"`init`(a: Int, b: Int, c: Int, d: Int, e: Int, f: Int) {}",
"init?(a: Int, b: Int, c: Int, d: Int, e: Int, f: Int) {}",
"func f2(p1: Int, p2: Int) { }",
@@ -29,6 +30,7 @@ public struct FunctionParameterCountRule: ASTRule, ConfigurationProviderRule {
],
triggeringExamples: [
"func f(a: Int, b: Int, c: Int, d: Int, e: Int, f: Int) {}",
"func initialValue(a: Int, b: Int, c: Int, d: Int, e: Int, f: Int) {}",
"func f(a: Int, b: Int, c: Int, d: Int, e: Int, f: Int = 2, g: Int) {}",
"struct Foo {\n" +
"init(a: Int, b: Int, c: Int, d: Int, e: Int, f: Int) {}\n" +
@@ -44,16 +46,17 @@ public struct FunctionParameterCountRule: ASTRule, ConfigurationProviderRule {
let nameOffset = Int(dictionary["key.nameoffset"] as? Int64 ?? 0)
let length = Int(dictionary["key.namelength"] as? Int64 ?? 0)
let substructure = dictionary["key.substructure"] as? [SourceKitRepresentable] ?? []
if functionIsInitializer(file, offset: nameOffset, length: length) {
return []
}
let substructure = dictionary["key.substructure"] as? [SourceKitRepresentable] ?? []
let minThreshold = configuration.params.map({ $0.value }).min(by: <)
let allParameterCount =
allFunctionParameterCount(substructure, offset: nameOffset, length: length)
let allParameterCount = allFunctionParameterCount(substructure, offset: nameOffset,
length: length)
if allParameterCount < minThreshold! {
return []
}
@@ -74,7 +77,7 @@ public struct FunctionParameterCountRule: ASTRule, ConfigurationProviderRule {
}
fileprivate func allFunctionParameterCount(_ structure: [SourceKitRepresentable],
offset: Int, length: Int) -> Int {
offset: Int, length: Int) -> Int {
var parameterCount = 0
for substructure in structure {
guard let subDict = substructure as? [String: SourceKitRepresentable],
@@ -95,18 +98,22 @@ public struct FunctionParameterCountRule: ASTRule, ConfigurationProviderRule {
}
fileprivate func defaultFunctionParameterCount(_ file: File, offset: Int, length: Int) -> Int {
let equalCharacter = Character("=")
return (file.contents as NSString)
.substringWithByteRange(start: offset, length: length)?
.characters.filter { $0 == equalCharacter }.count ?? 0
return file.contents.substringWithByteRange(start: offset, length: length)?
.characters.filter { $0 == "=" }.count ?? 0
}
fileprivate func functionIsInitializer(_ file: File, offset: Int, length: Int) -> Bool {
if let function = (file.contents as NSString)
.substringWithByteRange(start: offset, length: length), function.hasPrefix("init") {
guard let name = file.contents.substringWithByteRange(start: offset, length: length),
name.hasPrefix("init"),
let funcName = name.components(separatedBy: "(").first else {
return false
}
if funcName == "init" { // fast path
return true
}
return false
let nonAlphas = CharacterSet.alphanumerics.inverted
let alphaNumericName = funcName.components(separatedBy: nonAlphas).joined()
return alphaNumericName == "init"
}
fileprivate let functionKinds: [SwiftDeclarationKind] = [