Report json

Author: ikhvorost

Sources/SwiftSource/SwiftAccessLevel.swift

@@ -24,7 +24,7 @@
 import SwiftSyntax
 
 
-public enum SwiftAccessLevel: Int, Decodable {
+public enum SwiftAccessLevel: Int, Codable {
   case `open`
   case `public`
   case `internal`

Sources/SwiftSource/SwiftComment.swift

@@ -24,7 +24,7 @@
 import SwiftSyntax
 
 
-public struct SwiftComment: Decodable {
+public struct SwiftComment: Codable {
   public let text: String
   public var isDoc: Bool
 

Sources/SwiftSource/SwiftDeclaration.swift

@@ -47,7 +47,7 @@ fileprivate struct StringBuilder {
   }
 }
 
-public struct SwiftDeclaration: Decodable {
+public struct SwiftDeclaration: Codable {
   public let comments: [SwiftComment]
   public let accessLevel: SwiftAccessLevel
   public var keyword: SwiftKeyword

Sources/SwiftSource/SwiftKeyword.swift

@@ -24,7 +24,7 @@
 import SwiftSyntax
 
 
-public enum SwiftKeyword: String, Decodable {
+public enum SwiftKeyword: String, Codable {
   case actor
   case `associatedtype`
   case `case`

Sources/SwiftSource/SwiftSource.swift

@@ -25,7 +25,7 @@ import Foundation
 import SwiftSyntax
 
 
-public struct SwiftSource: Decodable {
+public struct SwiftSource: Codable {
   public let url: URL?
   public let declarations: [SwiftDeclaration]
 

Sources/swift-doc-coverage/main.swift

@@ -116,7 +116,7 @@ struct SwiftDocCoverage: ParsableCommand {
     }
 
     let totalTime = Date()
-    var i = 0
+    var index = 0
 
     // Sources
     sources = try urls.map { url in
@@ -127,10 +127,10 @@ struct SwiftDocCoverage: ParsableCommand {
       if report != .json {
         let declarations = source.declarations(level: minimumAccessLevel.accessLevel)
         if declarations.count > 0 {
-          i += 1
+          index += 1
           let filePath = url.absoluteString
           if report == .coverage {
-            Self.coverage(i: i, time: sourceTime, filePath: filePath, declarations: declarations, out: out)
+            Self.coverage(index: index, time: sourceTime, filePath: filePath, declarations: declarations, out: out)
           }
           else if report == .warnings {
             Self.warnings(filePath: filePath, declarations: declarations, out: out)
@@ -156,14 +156,13 @@ struct SwiftDocCoverage: ParsableCommand {
       out?.write("\nTotal: \(coverage)% [\(documentedCount)/\(totalCount)] (\(Self.string(from: -totalTime.timeIntervalSinceNow)))")
     }
     else if report == .json {
-      print(sources)
-//      let encoder = JSONEncoder()
-//      encoder.outputFormatting = .prettyPrinted
-//
-//      let data = try encoder.encode(sources)
-//      let json = String(data: data, encoding: .utf8)!
-//
-//      output.write(json)
+      let encoder = JSONEncoder()
+      encoder.outputFormatting = .prettyPrinted
+
+      let data = try encoder.encode(sources)
+      let json = String(data: data, encoding: .utf8)!
+
+      out?.write(json)
     }
   }
 
@@ -247,7 +246,7 @@ struct SwiftDocCoverage: ParsableCommand {
     return time
   }
 
-  static func coverage(i: Int, time: Date, filePath: String, declarations: [SwiftDeclaration], out: Output?) {
+  static func coverage(index: Int, time: Date, filePath: String, declarations: [SwiftDeclaration], out: Output?) {
     assert(declarations.count > 0)
 
     let undocumented = declarations.filter { $0.isDocumented == false }
@@ -256,7 +255,7 @@ struct SwiftDocCoverage: ParsableCommand {
     let documentedCount = totalCount - undocumented.count
     let coverage = documentedCount * 100 / totalCount
 
-    out?.write("\(i)) \(filePath): \(coverage)% [\(documentedCount)/\(totalCount)] (\(string(from: -time.timeIntervalSinceNow)))")
+    out?.write("\(index)) \(filePath): \(coverage)% [\(documentedCount)/\(totalCount)] (\(string(from: -time.timeIntervalSinceNow)))")
 
     if undocumented.count > 0 {
       let fileName = NSString(string: filePath).lastPathComponent

Tests/SwiftDocCoverageTests/SwiftDocCoverageTests.swift

@@ -491,6 +491,21 @@ final class SwiftDocCoverageTests: XCTestCase {
     XCTAssert(cmd.sources[0].declarations(level: .private).count == 4)
   }
 
+  func test_warnings() throws {
+    let output = Output()
+    _ = try SwiftDocCoverage.run(output: output, rectFileURL.path, "--report", "warnings")
+    XCTAssert(output.buffer.contains("Rect.swift:9:3: warning: No documentation for 'var Rect.size'.") == true)
+    XCTAssert(output.buffer.contains("Rect.swift:12:3: warning: No documentation for 'var Rect.center'.") == true)
+  }
+  
+  func test_json() throws {
+    let output = Output()
+    _ = try SwiftDocCoverage.run(output: output, rectFileURL.path, "--report", "json")
+    let sources = try JSONDecoder().decode([SwiftSource].self, from: output.buffer.data(using: .utf8)!)
+    XCTAssert(sources.count == 1)
+    XCTAssert(sources[0].declarations.count == 4)
+  }
+  
   func test_file() throws {
     let cmd = try SwiftDocCoverage.run(rectFileURL.path)
     XCTAssert(cmd.sources.count == 1)