Truncate markdown results

Author: ileitch

CHANGELOG.md

@@ -7,7 +7,7 @@
 ##### Enhancements
 
 - Added `--write-results <file>` option.
-- Added `markdown` output format.
+- Added `github-markdown` output format.
 
 ##### Bug Fixes
 

Sources/Configuration/OutputFormat.swift

@@ -7,7 +7,7 @@ public enum OutputFormat: String, CaseIterable {
     case checkstyle
     case codeclimate
     case githubActions = "github-actions"
-    case markdown
+    case githubMarkdown = "github-markdown"
 
     public static let `default` = OutputFormat.xcode
 

Sources/PeripheryKit/Results/GitHubMarkdownFormatter.swift

@@ -0,0 +1,60 @@
+import Configuration
+import SystemPackage
+
+final class GitHubMarkdownFormatter: OutputFormatter {
+    let configuration: Configuration
+    lazy var currentFilePath: FilePath = .current
+
+    init(configuration: Configuration) {
+        self.configuration = configuration
+    }
+
+    func format(_ results: [ScanResult], colored _: Bool) throws -> String? {
+        guard !results.isEmpty else {
+            return "No unused code detected."
+        }
+
+        let visibleResults = results.prefix(2).flatMap { format($0) }
+        let expandableResults = results.dropFirst(2).flatMap { format($0) }
+        let title = results.count == 1 ? "Result" : "Results"
+
+        var markdown = """
+        | \(results.count) \(title) |
+        | :- |
+        \(visibleResults.joined(separator: "\n"))
+        """
+
+        if !expandableResults.isEmpty {
+            let expandableTitle = expandableResults.count == 1 ? "result" : "results"
+            markdown += """
+
+            <details>
+              <summary>Show remaining \(expandableResults.count) \(expandableTitle)</summary>
+              <br>
+
+              | |
+              | :- |
+              \(expandableResults.joined(separator: "\n"))
+
+            </details>
+            """
+        }
+
+        return markdown
+    }
+
+    // MARK: - Private
+
+    private func format(_ result: ScanResult) -> [String] {
+        describe(result, colored: false).map { location, description in
+            "| **\(description)**<br>\(locationDescription(location)) |"
+        }
+    }
+}
+
+func lol1() {}
+func lol2() {}
+func lol3() {}
+func lol4() {}
+func lol5() {}
+func lol6() {}

Sources/PeripheryKit/Results/MarkdownFormatter.swift

@@ -110,8 +110,8 @@ public extension OutputFormat {
             CheckstyleFormatter.self
         case .githubActions:
             GitHubActionsFormatter.self
-        case .markdown:
-            MarkdownFormatter.self
+        case .githubMarkdown:
+            GitHubMarkdownFormatter.self
         }
     }
 }