Move suppression logic up to FileIterator

Author: samdeane

Documentation/Configuration.md

@@ -11,9 +11,6 @@ top-level keys and values:
 *   `version` _(number)_: The version of the configuration file. For now, this
     should always be `1`.
 
-*   `skipAll` _(boolean)_: If this is true, all other configuration 
-    options are ignored, and formatting/linting is disabled.
-    
 *   `lineLength` _(number)_: The maximum allowed length of a line, in
     characters.
 

Sources/SwiftFormat/API/Configuration.swift

@@ -24,19 +24,9 @@ internal let highestSupportedConfigurationVersion = 1
 /// Holds the complete set of configured values and defaults.
 public struct Configuration: Codable, Equatable {
 
-  /// Name of the configuration file to look for.
-  /// The presence of this file in a directory will cause the formatter
-  /// to use the configuration specified in that file.
-  private static let configurationFileName = ".swift-format"
-
-  /// Name of the suppression file to look for.
-  /// The presence of this file in a directory will cause the formatter
-  /// to skip formatting files in that directory and its subdirectories.
-  private static let suppressionFileName = ".swift-format-ignore"
 
   private enum CodingKeys: CodingKey {
     case version
-    case skipAll
     case maximumBlankLines
     case lineLength
     case spacesBeforeEndOfLineComments
@@ -70,9 +60,6 @@ public struct Configuration: Codable, Equatable {
 
   /// MARK: Common configuration
 
-  /// Is all formatting disbled?
-  public var skipAll = false
-
   /// The dictionary containing the rule names that we wish to run on. A rule is not used if it is
   /// marked as `false`, or if it is missing from the dictionary.
   public var rules: [String: Bool]
@@ -276,13 +263,6 @@ public struct Configuration: Codable, Equatable {
 
   /// Creates a new `Configuration` by loading it from a configuration file.
   public init(contentsOf url: URL) throws {
-    if url.lastPathComponent == Self.suppressionFileName {
-      var config = Configuration()
-      config.skipAll = true
-      self = config
-      return
-    }
-
     let data = try Data(contentsOf: url)
     try self.init(data: data)
   }
@@ -316,9 +296,6 @@ public struct Configuration: Codable, Equatable {
     // default-initialized instance.
     let defaults = Configuration()
 
-    self.skipAll = 
-      try container.decodeIfPresent(Bool.self, forKey: .skipAll) 
-      ?? false
     self.maximumBlankLines =
       try container.decodeIfPresent(Int.self, forKey: .maximumBlankLines)
       ?? defaults.maximumBlankLines
@@ -406,7 +383,6 @@ public struct Configuration: Codable, Equatable {
     var container = encoder.container(keyedBy: CodingKeys.self)
 
     try container.encode(version, forKey: .version)
-    try container.encode(skipAll, forKey: .skipAll)
     try container.encode(maximumBlankLines, forKey: .maximumBlankLines)
     try container.encode(lineLength, forKey: .lineLength)
     try container.encode(spacesBeforeEndOfLineComments, forKey: .spacesBeforeEndOfLineComments)
@@ -451,11 +427,7 @@ public struct Configuration: Codable, Equatable {
     }
     repeat {
       candidateDirectory.deleteLastPathComponent()
-      let suppressingFile = candidateDirectory.appendingPathComponent(Self.suppressionFileName)
-      if FileManager.default.isReadableFile(atPath: suppressingFile.path) {
-        return suppressingFile
-      }
-      let candidateFile = candidateDirectory.appendingPathComponent(Self.configurationFileName)
+      let candidateFile = candidateDirectory.appendingPathComponent(".swift-format")
       if FileManager.default.isReadableFile(atPath: candidateFile.path) {
         return candidateFile
       }

Sources/SwiftFormat/API/SwiftFormatter.swift

@@ -106,12 +106,6 @@ public final class SwiftFormatter {
     // also does not touch an empty file even if the setting to add trailing newlines is enabled.)
     guard !source.isEmpty else { return }
 
-    // If skipAll is set, just emit the source as-is.
-    guard !configuration.skipAll else {
-      outputStream.write(source)
-      return
-    }
-
     let sourceFile = try parseAndEmitDiagnostics(
       source: source,
       operatorTable: .standardOperators,

Sources/SwiftFormat/API/SwiftLinter.swift

@@ -93,11 +93,6 @@ public final class SwiftLinter {
     // newline from being diagnosed for an empty file. (This is consistent with clang-format, which
     // also does not touch an empty file even if the setting to add trailing newlines is enabled.)
     guard !source.isEmpty else { return }
-
-    // If skipAll is set, do nothing.
-    guard !configuration.skipAll else {
-      return
-    }
 
     let sourceFile = try parseAndEmitDiagnostics(
       source: source,

Sources/SwiftFormat/Utilities/FileIterator.swift

@@ -17,6 +17,11 @@ import Foundation
 @_spi(Internal)
 public struct FileIterator: Sequence, IteratorProtocol {
 
+  /// Name of the suppression file to look for.
+  /// The presence of this file in a directory will cause the formatter
+  /// to skip formatting files in that directory and its subdirectories.
+  private static let suppressionFileName = ".swift-format-ignore"
+
   /// List of file and directory URLs to iterate over.
   private let urls: [URL]
 
@@ -83,6 +88,11 @@ public struct FileIterator: Sequence, IteratorProtocol {
           fallthrough
 
         case .typeDirectory:
+          let suppressionFile = next.appendingPathComponent(Self.suppressionFileName)
+          if FileManager.default.fileExists(atPath: suppressionFile.path) {
+            continue
+          }
+
           dirIterator = FileManager.default.enumerator(
             at: next,
             includingPropertiesForKeys: nil,