mirror of
https://github.com/realm/SwiftLint.git
synced 2026-06-06 20:18:40 +00:00
Chris Eidhof
40 lines
1.0 KiB
Swift
40 lines
1.0 KiB
Swift
//
|
|
// TodoRule.swift
|
|
// SwiftLint
|
|
//
|
|
// Created by JP Simard on 2015-05-16.
|
|
// Copyright (c) 2015 Realm. All rights reserved.
|
|
//
|
|
|
|
import SourceKittenFramework
|
|
|
|
public struct TodoRule: Rule {
|
|
let identifier = "todo"
|
|
|
|
public init() { }
|
|
|
|
public func validateFile(file: File) -> [StyleViolation] {
|
|
return file.matchPattern("// (TODO|FIXME):", withSyntaxKinds: [.Comment]).map { range in
|
|
return StyleViolation(type: .TODO,
|
|
location: Location(file: file, offset: range.location),
|
|
severity: .Low,
|
|
reason: "TODOs and FIXMEs should be avoided")
|
|
}
|
|
}
|
|
|
|
public let example: RuleExample? = RuleExample(
|
|
ruleName: "Todo Rule",
|
|
ruleDescription: "This rule checks whether you removed all TODOs and FIXMEs.",
|
|
correctExamples: [
|
|
"let string = \"// TODO:\"\n",
|
|
"let string = \"// FIXME:\"\n"
|
|
],
|
|
failingExamples: [
|
|
"// TODO:\n",
|
|
"// FIXME:\n"
|
|
]
|
|
)
|
|
|
|
|
|
}
|