Merge branch 'main' into add-extended-types-flag

Author: ethan-kusters

Sources/snippet-extract/Utility/SymbolGraph+Snippet.swift

@@ -19,14 +19,18 @@ extension SymbolGraph.Symbol {
         let identifier = SymbolGraph.Symbol.Identifier(precise: "$snippet__\(moduleName).\(basename)", interfaceLanguage: "swift")
         let names = SymbolGraph.Symbol.Names.init(title: basename, navigator: nil, subHeading: nil, prose: nil)
 
-        var pathComponents = snippet.sourceFile.absoluteURL.deletingPathExtension().pathComponents[...]
+        var pathComponents = Array(snippet.sourceFile.absoluteURL.deletingPathExtension().pathComponents[...])
 
         guard let snippetsPathComponentIndex = pathComponents.firstIndex(where: {
             $0 == "Snippets"
         }) else {
             throw SnippetExtractCommand.ArgumentError.snippetNotContainedInSnippetsDirectory(snippet.sourceFile)
         }
-        pathComponents = pathComponents[snippetsPathComponentIndex...]
+
+        // In theory, there may be differently named snippet root directories in the future.
+        // Replace that path component with the standardized `Snippets`.
+        pathComponents.replaceSubrange(pathComponents.startIndex...snippetsPathComponentIndex,
+                                       with: CollectionOfOne("Snippets"))
 
         let docComment = SymbolGraph.LineList(snippet.explanation
                                     .split(separator: "\n", maxSplits: Int.max, omittingEmptySubsequences: false)
@@ -39,7 +43,7 @@ extension SymbolGraph.Symbol {
 
         self.init(identifier: identifier,
                   names: names,
-                  pathComponents: ["Snippets"] + Array(pathComponents),
+                  pathComponents: pathComponents,
                   docComment: docComment,
                   accessLevel: accessLevel,
                   kind: kind,

Tests/SwiftDocCPluginUtilitiesTests/Snippets/SnippetSymbolTests.swift

@@ -30,4 +30,15 @@ class SnippetSymbolTests: XCTestCase {
             }
         })
     }
+
+    func testPathComponentsForSnippetSymbol() throws {
+        let source = """
+        // A snippet.
+        foo() {}
+        """
+        let snippet = Snippets.Snippet(parsing: source,
+                                       sourceFile: URL(fileURLWithPath: "/path/to/my-package/Snippets/ASnippet.swift"))
+        let symbol = try SymbolGraph.Symbol(snippet, moduleName: "my-package")
+        XCTAssertEqual(["Snippets", "ASnippet"], symbol.pathComponents)
+    }
 }

bin/test

@@ -49,11 +49,11 @@ then
   git clone -b "${SWIFT_DOCC_RENDER_ARTIFACT_BRANCH}" "${SWIFT_DOCC_RENDER_ARTIFACT_REPO}" "$SWIFT_DOCC_RENDER_ARTIFACT_ROOT" || exit 1
 
   echo "Building docc..."
-  swift build --package-path "$SWIFT_DOCC_ROOT" --configuration release || exit 1
+  swift build --package-path "$SWIFT_DOCC_ROOT" --product docc --configuration release || exit 1
 
   export DOCC_EXEC="$(swift build --package-path "$SWIFT_DOCC_ROOT" --show-bin-path --configuration release)/docc"
   if [[ ! -f "$DOCC_EXEC" ]]; then
-    echo "docc executable not found, expected at $SWIFT_DOCC_EXEC"
+    echo "docc executable not found, expected at $DOCC_EXEC"
     exit 1
   else
     echo "Using docc executable: $DOCC_EXEC"