Deprecate DocumentationWorkspaceDataProvider

Author: d-ronnqvist

Sources/SwiftDocC/Infrastructure/Workspace/DocumentationWorkspaceDataProvider.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See https://swift.org/LICENSE.txt for license information
@@ -11,6 +11,7 @@
 import Foundation
 
 /// A type that vends bundles and responds to requests for data.
+@available(*, deprecated, message: "Pass the context its inputs at initialization instead. This deprecated API will be removed after 6.2 is released")
 public protocol DocumentationWorkspaceDataProvider {
     /// A string that uniquely identifies this data provider.
     ///
@@ -35,6 +36,7 @@ public protocol DocumentationWorkspaceDataProvider {
     func bundles(options: BundleDiscoveryOptions) throws -> [DocumentationBundle]
 }
 
+@available(*, deprecated, message: "Pass the context its inputs at initialization instead. This deprecated API will be removed after 6.2 is released")
 public extension DocumentationWorkspaceDataProvider {
     /// Returns the documentation bundles that your data provider provides; discovered with the default options.
     ///

Sources/SwiftDocC/Infrastructure/Workspace/LocalFileSystemDataProvider+BundleDiscovery.swift

@@ -10,7 +10,8 @@
 
 import Foundation
 
-extension LocalFileSystemDataProvider {
+@available(*, deprecated, message: "Use 'DocumentationContext.InputProvider' instead. This deprecated API will be removed after 6.2 is released")
+extension LocalFileSystemDataProvider: DocumentationWorkspaceDataProvider {
     public func bundles(options: BundleDiscoveryOptions) throws -> [DocumentationBundle] {
         var bundles = try bundlesInTree(fileSystem, options: options)
 

Sources/SwiftDocC/Infrastructure/Workspace/LocalFileSystemDataProvider.swift

@@ -11,7 +11,7 @@
 import Foundation
 
 /// A type that provides documentation bundles that it discovers by traversing the local file system.
-public struct LocalFileSystemDataProvider: DocumentationWorkspaceDataProvider, FileSystemProvider {
+public struct LocalFileSystemDataProvider: FileSystemProvider {
     public var identifier: String = UUID().uuidString
 
     /// The location that this provider searches for documentation bundles in.

Tests/SwiftDocCTests/Infrastructure/Input Discovery/DocumentationInputsProviderTests.swift

@@ -14,6 +14,8 @@ import SwiftDocCTestUtilities
 
 class DocumentationInputsProviderTests: XCTestCase {
 
+    // After 6.2 we can update this test to verify that the input provider discovers the same inputs regardless of FileManagerProtocol
+    @available(*, deprecated, message: "This test uses `LocalFileSystemDataProvider` as a `DocumentationWorkspaceDataProvider` which is deprecated and will be removed after 6.2 is released")
     func testDiscoversSameFilesAsPreviousImplementation() throws {
         let folderHierarchy = Folder(name: "one", content: [
             Folder(name: "two", content: [