refactor: changes to standardize code with the strategy used in swiftlang#34

Author: sofiaromorales

Sources/SwiftDocCPluginUtilities/ParsedArguments.swift

@@ -153,19 +153,13 @@ public struct ParsedArguments {
     /// Creates a new set of parsed arguments with the given arguments.
     public init(_ arguments: [String]) {
         self.arguments = arguments
-        
         let symbolGraphArguments = arguments.filter(for: .dumpSymbolGraph)
 
         self.symbolGraphArguments = ParsedArguments.ArgumentConsumer.dumpSymbolGraph.flags.filter { option in
             option.parsedValues.contains(where: symbolGraphArguments.contains)
         }
     }
 
-    // Build array with plugin flags that modify the symbol graph generation,
-    // filtering from the available custom symbol graph options those
-    // that correspond to the received flags
-    var symbolGraphArguments: [PluginFlag]
-    
     /// The command-line options required by the `docc` tool.
     private static let requiredOptions: [CommandLineOption] = [
         .fallbackDisplayName,
@@ -180,19 +174,14 @@ public struct ParsedArguments {
         "--index",
     ]
 
-    /// The plugin-flag options to customize the Symbol Graph generation
-    let customSymbolGraphOptions: [PluginFlag] = [
-        .skipSynthesizedSymbols
-    ]
-    
     // Build array with plugin flags that modify the symbol graph generation,
     // filtering from the available custom symbol graph options those
     // that correspond to the received flags
     var symbolGraphArguments: [PluginFlag]
 
     private static let argumentsTransformers: [ArgumentsTransforming] = [
         PluginFlag.disableIndex,
-        PluginFlag.extendedTypes
+        PluginFlag.extendedTypes,
         PluginFlag.skipSynthesizedSymbols
     ]
 }
@@ -212,7 +201,8 @@ private extension ParsedArguments {
             switch self {
             case .dumpSymbolGraph:
                 return [
-                    PluginFlag.extendedTypes
+                    PluginFlag.extendedTypes,
+                    PluginFlag.skipSynthesizedSymbols
                 ]
             case .docc:
                 return []

Tests/SwiftDocCPluginUtilitiesTests/HelpInformationTests.swift

@@ -21,6 +21,9 @@ final class HelpInformationTests: XCTestCase {
             doccExecutableURL: URL(fileURLWithPath: "/")
         )
 
+        print("includeExtendedTypesSection")
+        print(includeExtendedTypesSection)
+        
         XCTAssertEqual(
             convertHelpInformation,
             """
@@ -42,8 +45,7 @@ final class HelpInformationTests: XCTestCase {
                     Produces a DocC archive that is best-suited for hosting online but incompatible with Xcode.
               --experimental-skip-synthesized-symbols
                                       Exclude synthesized symbols from the generated documentation
-                    Experimental feature that produces a DocC archive without compiler synthesized symbols.
-                    Produces a DocC archive that is best-suited for hosting online but incompatible with Xcode.\(includeExtendedTypesSection)
+                    Experimental feature that produces a DocC archive without compiler synthesized symbols.\(includeExtendedTypesSection)
 
             DOCC OPTIONS:
               --platform <platform>   Set the current release version of a platform.
@@ -135,8 +137,7 @@ final class HelpInformationTests: XCTestCase {
                     Produces a DocC archive that is best-suited for hosting online but incompatible with Xcode.
               --experimental-skip-synthesized-symbols
                                       Exclude synthesized symbols from the generated documentation
-                    Experimental feature that produces a DocC archive without compiler synthesized symbols.
-                    Produces a DocC archive that is best-suited for hosting online but incompatible with Xcode.\(includeExtendedTypesSection)
+                    Experimental feature that produces a DocC archive without compiler synthesized symbols.\(includeExtendedTypesSection)
             
             DOCC OPTIONS:
               --platform <platform>   Set the current release version of a platform.

Tests/SwiftDocCPluginUtilitiesTests/ParsedArgumentsTests.swift

@@ -444,7 +444,7 @@ final class ParsedArgumentsTests: XCTestCase {
     }
 
     func testDocCArgumentsWithDumpSymbolGraphArguments() {
-        let dumpSymbolGraphArguments = ParsedArguments(["--include-extended-types"])
+        let dumpSymbolGraphArguments = ParsedArguments(["--include-extended-types", "--experimental-skip-synthesized-symbols"])
 
         let doccArguments = dumpSymbolGraphArguments.doccArguments(
             action: .convert,
@@ -455,30 +455,14 @@ final class ParsedArgumentsTests: XCTestCase {
             outputPath: "/my/output-path"
         )
 
-        XCTAssertFalse(doccArguments.contains("--include-extended-types"))
+        XCTAssertFalse(doccArguments.contains("--experimental-skip-synthesized-symbols"))
     }
 
     func testDumpSymbolGraphArguments() {
-        let dumpSymbolGraphArguments = ParsedArguments(["--include-extended-types"])
+        let dumpSymbolGraphArguments = ParsedArguments(["--include-extended-types", "--experimental-skip-synthesized-symbols"])
 
-        XCTAssertEqual(dumpSymbolGraphArguments.symbolGraphArguments, [.extendedTypes])
+        XCTAssertEqual(dumpSymbolGraphArguments.symbolGraphArguments, [.extendedTypes, .skipSynthesizedSymbols])
     }
-    
-    func testDocCSymbolGraphArgumentsForSynthesizedSymbols() {
-        let excludeSynthesizedSymbolsArguments = ParsedArguments(
-            ["--experimental-skip-synthesized-symbols"]
-        )
-        XCTAssertEqual(
-            excludeSynthesizedSymbolsArguments.symbolGraphArguments,
-            [.skipSynthesizedSymbols]
-        )
-        let emptyArguments = ParsedArguments(
-            []
-        )
-        XCTAssertNotEqual(
-            emptyArguments.symbolGraphArguments,
-            [.skipSynthesizedSymbols]
-        )
     func testDumpSymbolGraphArgumentsWithDocCArguments() {
         let dumpSymbolGraphArguments = ParsedArguments(["--fallback-default-module-kind", "Executable"])