make missing_docs rule opt-in

realm · Jan 13, 2016 · 509df11 · 509df11
1 parent f210130
commit 509df11
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/Source/SwiftLintFramework/Rules/MissingDocsRule.swift b/Source/SwiftLintFramework/Rules/MissingDocsRule.swift
@@ -67,7 +67,7 @@ public enum AccessControlLevel: String {
     }
 }
 
-public struct MissingDocsRule: ParameterizedRule {
+public struct MissingDocsRule: ParameterizedRule, OptInRule {
     public init() {
         self.init(parameters: [
             RuleParameter(severity: .Warning, value: .Public),

diff --git a/Source/SwiftLintFrameworkTests/ConfigurationTests.swift b/Source/SwiftLintFrameworkTests/ConfigurationTests.swift
@@ -36,7 +36,7 @@ class ConfigurationTests: XCTestCase {
             ["nesting", "todo"],
             "initializing Configuration with valid rules in Dictionary should succeed")
         let expectedIdentifiers = Array(masterRuleList.list.keys)
-            .filter({ !["nesting", "todo"].contains($0) })
+            .filter({ !["nesting", "todo", "missing_docs"].contains($0) })
         let configuredIdentifiers = disabledConfig.rules.map {
             $0.dynamicType.description.identifier
         }
@@ -57,7 +57,7 @@ class ConfigurationTests: XCTestCase {
             [validRule],
             "initializing Configuration with valid rules in YAML string should succeed")
         let expectedIdentifiers = Array(masterRuleList.list.keys)
-            .filter({ ![validRule].contains($0) })
+            .filter({ ![validRule, "missing_docs"].contains($0) })
         let configuredIdentifiers = configuration.rules.map {
             $0.dynamicType.description.identifier
         }

diff --git a/Source/SwiftLintFrameworkTests/TestHelpers.swift b/Source/SwiftLintFrameworkTests/TestHelpers.swift
@@ -24,7 +24,9 @@ func violations(string: String, config: Configuration = Configuration()) -> [Sty
 
 private func violations(string: String, _ description: RuleDescription) -> [StyleViolation] {
     let disabledRules = allRuleIdentifiers.filter { $0 != description.identifier }
-    return violations(string, config: Configuration(disabledRules: disabledRules)!)
+    let enabledRules = allRuleIdentifiers.filter { $0 == description.identifier }
+    let config = Configuration(disabledRules: disabledRules, enabledRules: enabledRules)!
+    return violations(string, config: config)
 }
 
 private func assertCorrection(before: String, expected: String) {