Skip to content

Commit d8876fe

Browse files
committed
spliting documentation tests
1 parent 29c5cad commit d8876fe

11 files changed

Lines changed: 9 additions & 20 deletions

File tree

Package.swift

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,5 +120,10 @@ let package = Package(
120120
dependencies: ["SyntaxKit"],
121121
swiftSettings: swiftSettings
122122
),
123+
.testTarget(
124+
name: "SyntaxDocTests",
125+
dependencies: ["SyntaxKit"],
126+
swiftSettings: swiftSettings
127+
),
123128
]
124129
)

Sources/SyntaxKit/Utilities/EnumCase.swift

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,5 +145,4 @@ public struct EnumCase: CodeBlock {
145145
public func equals(_ value: Double) -> Self {
146146
self.equals(.float(value))
147147
}
148-
149148
}

Tests/SyntaxKitTests/Integration/DocumentationExampleTests.swift renamed to Tests/SyntaxDocTests/DocumentationExampleTests.swift

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ import SwiftParser
33
import SwiftSyntax
44
import Testing
55

6-
@testable import SyntaxKit
7-
86
/// Integration tests that validate all code examples in DocC documentation
97
@Suite("Documentation Code Examples")
108
internal struct DocumentationExampleTests {

Tests/SyntaxKitTests/Integration/DocumentationTestHarness.swift renamed to Tests/SyntaxDocTests/DocumentationTestHarness.swift

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ import SwiftParser
33
import SwiftSyntax
44
import Testing
55

6-
@testable import SyntaxKit
76

87
/// Harness for extracting and testing documentation code examples
98
internal class DocumentationTestHarness {
@@ -174,13 +173,13 @@ internal class DocumentationTestHarness {
174173

175174
// If compilation succeeded, try to run it (for runnable examples)
176175
if isRunnableExample(code) {
177-
let executeResult = try await executeCompiledSwift(tempFile)
176+
// let executeResult = try await executeCompiledSwift(tempFile)
178177
return ValidationResult(
179-
success: executeResult.success,
178+
success: true,
180179
filePath: filePath,
181180
lineNumber: lineNumber,
182181
testType: .execution,
183-
error: executeResult.error
182+
error: nil
184183
)
185184
} else {
186185
// Just compilation test for non-runnable code
@@ -332,13 +331,6 @@ internal class DocumentationTestHarness {
332331
return CompilationResult(success: true, error: nil)
333332
}
334333

335-
/// Executes compiled Swift code
336-
private func executeCompiledSwift(_ fileURL: URL) async throws -> CompilationResult {
337-
// For documentation examples, we generally only test compilation
338-
// Execution would require more complex setup with proper module dependencies
339-
CompilationResult(success: true, error: nil)
340-
}
341-
342334
/// Determines if a code example should be executed (vs just compiled)
343335
private func isRunnableExample(_ code: String) -> Bool {
344336
// Simple heuristics for runnable examples
@@ -442,8 +434,7 @@ internal class DocumentationTestHarness {
442434

443435
let projectRoot =
444436
currentFileURL
445-
.deletingLastPathComponent() // Tests/SyntaxKitTests/Integration
446-
.deletingLastPathComponent() // Tests/SyntaxKitTests
437+
.deletingLastPathComponent() // Tests/SyntaxDocTests
447438
.deletingLastPathComponent() // Tests
448439
.deletingLastPathComponent() // Project root
449440

Tests/SyntaxKitTests/Integration/DocumentationTestTypes/CodeBlock.swift renamed to Tests/SyntaxDocTests/DocumentationTestTypes/CodeBlock.swift

File renamed without changes.

Tests/SyntaxKitTests/Integration/DocumentationTestTypes/CodeBlockType.swift renamed to Tests/SyntaxDocTests/DocumentationTestTypes/CodeBlockType.swift

File renamed without changes.

Tests/SyntaxKitTests/Integration/DocumentationTestTypes/CompilationResult.swift renamed to Tests/SyntaxDocTests/DocumentationTestTypes/CompilationResult.swift

File renamed without changes.

Tests/SyntaxKitTests/Integration/DocumentationTestTypes/DocumentationTestError.swift renamed to Tests/SyntaxDocTests/DocumentationTestTypes/DocumentationTestError.swift

File renamed without changes.

Tests/SyntaxKitTests/Integration/DocumentationTestTypes/TestType.swift renamed to Tests/SyntaxDocTests/DocumentationTestTypes/TestType.swift

File renamed without changes.

Tests/SyntaxKitTests/Integration/DocumentationTestTypes/ValidationResult.swift renamed to Tests/SyntaxDocTests/DocumentationTestTypes/ValidationResult.swift

File renamed without changes.

0 commit comments

Comments
 (0)