Added skipsHiddenFiles

Author: khvorost-dish

Sources/SwiftDocCoverage/Coverage.swift

@@ -28,7 +28,7 @@ extension String : LocalizedError {
   public var errorDescription: String? { self }
 }
 
-fileprivate func findFiles(path: String, ext: String) throws -> [URL]  {
+fileprivate func findFiles(path: String, ext: String, skipsHiddenFiles: Bool) throws -> [URL]  {
   var isDirectory: ObjCBool = false
   guard FileManager.default.fileExists(atPath: path, isDirectory: &isDirectory) else {
     throw "Path not found."
@@ -38,7 +38,8 @@ fileprivate func findFiles(path: String, ext: String) throws -> [URL]  {
     var urls = [URL]()
     let url = URL(fileURLWithPath: path)
     let resourceKeys = Set<URLResourceKey>([.nameKey, .isDirectoryKey])
-    if let enumerator = FileManager.default.enumerator(at: url, includingPropertiesForKeys: [.isDirectoryKey]) {
+    let options: FileManager.DirectoryEnumerationOptions = skipsHiddenFiles ? [.skipsHiddenFiles] : []
+    if let enumerator = FileManager.default.enumerator(at: url, includingPropertiesForKeys: [.isDirectoryKey, .isHiddenKey], options: options) {
       for case let fileURL as URL in enumerator {
         guard let resourceValues = try? fileURL.resourceValues(forKeys: resourceKeys),
               let isDirectory = resourceValues.isDirectory, !isDirectory,
@@ -73,8 +74,8 @@ public struct Coverage {
     return formatter
   }()
 
-  public init(paths: [String], minAccessLevel: AccessLevel, output: Output = TerminalOutput()) throws {
-    self.urls = try paths.flatMap { try findFiles(path: $0, ext: ".swift") }
+  public init(paths: [String], skipsHiddenFiles: Bool = true, minAccessLevel: AccessLevel = .public, output: Output = TerminalOutput()) throws {
+    self.urls = try paths.flatMap { try findFiles(path: $0, ext: ".swift", skipsHiddenFiles: skipsHiddenFiles) }
     guard urls.count > 0 else {
       throw "Swift files not found."
     }

Sources/swift-doc-coverage/main.swift

@@ -56,6 +56,9 @@ struct SwiftDocCoverage: ParsableCommand {
   @Argument(help: "One or more paths to a directory containing Swift files.")
   var inputs: [String]
 
+  @Option(name: .shortAndLong, help: "An option to skip hidden files.")
+  var skipsHiddenFiles: Bool = true
+  
   @Option(name: .shortAndLong, help: "The minimum access level of the symbols considered for coverage statistics: \(AccessLevelArgument.open), \(AccessLevelArgument.public), \(AccessLevelArgument.internal), \(AccessLevelArgument.fileprivate), \(AccessLevelArgument.private).")
   var minimumAccessLevel: AccessLevelArgument = .public
 
@@ -71,7 +74,7 @@ struct SwiftDocCoverage: ParsableCommand {
       out = try FileOutput(path: path)
     }
 
-    let coverage = try Coverage(paths: inputs, minAccessLevel: minimumAccessLevel.accessLevel, output: out)
+    let coverage = try Coverage(paths: inputs, skipsHiddenFiles: skipsHiddenFiles, minAccessLevel: minimumAccessLevel.accessLevel, output: out)
 
     switch report {
       case .statistics:

Tests/SwiftDocCoverageTests/SwiftDocCoverageTests.swift

@@ -413,13 +413,13 @@ final class FileTests: XCTestCase {
   }
 
   func test_not_found() throws {
-    XCTAssertThrowsError(try Coverage(paths: [Self.directoryURL.appendingPathComponent("NotFound").path], minAccessLevel: .public)) { error in
+    XCTAssertThrowsError(try Coverage(paths: [Self.directoryURL.appendingPathComponent("NotFound").path])) { error in
       XCTAssert(error.localizedDescription == "Path not found.")
     }
   }
 
   func test_not_swift_file() throws {
-    XCTAssertThrowsError(try Coverage(paths: [Self.readmeURL.path], minAccessLevel: .public)) { error in
+    XCTAssertThrowsError(try Coverage(paths: [Self.readmeURL.path])) { error in
       XCTAssert(error.localizedDescription == "Not swift file.")
     }
   }
@@ -432,7 +432,7 @@ final class FileTests: XCTestCase {
   }
 
   func test_report() throws {
-    let coverage = try Coverage(paths: [Self.fileURL.path], minAccessLevel: .public)
+    let coverage = try Coverage(paths: [Self.fileURL.path])
     let report = try coverage.report()
 
     XCTAssert(report.totalCount == 4)
@@ -446,13 +446,13 @@ final class FileTests: XCTestCase {
     let tempDirectory = tempDirectory()
     defer { try? FileManager.default.removeItem(at: tempDirectory) }
 
-    XCTAssertThrowsError(try Coverage(paths: [tempDirectory.path], minAccessLevel: .public)) { error in
+    XCTAssertThrowsError(try Coverage(paths: [tempDirectory.path])) { error in
       XCTAssert(error.localizedDescription == "Swift files not found.")
     }
   }
 
   func test_directory() throws {
-    let coverage = try Coverage(paths: [Self.directoryURL.path], minAccessLevel: .public)
+    let coverage = try Coverage(paths: [Self.directoryURL.path])
     let report = try coverage.report()
 
     XCTAssert(report.totalCount == 4)
@@ -461,11 +461,13 @@ final class FileTests: XCTestCase {
   }
 
   func test_warnings() throws {
-    let coverage = try Coverage(paths: [Self.fileURL.path], minAccessLevel: .public)
+    let coverage = try Coverage(paths: [Self.fileURL.path])
     try coverage.reportWarnings()
   }
 }
 
+#if !os(watchOS)
+
 extension Process {
 
   func run(_ executableURL: URL, arguments: [String]? = nil) throws -> String {
@@ -552,3 +554,5 @@ final class ToolTests: XCTestCase {
     XCTAssert(text.contains("Total: 50%"))
   }
 }
+
+#endif