[SwiftRefactor] PackageManifest: Mark all of the refactorings and supporting types as SPI

xedin · xedin · commit 2f6937d85d80 · 2025-08-08T10:48:33.000-07:00
Avoid increasing public API surface of the swift-syntax for now
until the factorings are fully evaluated.
diff --git a/Sources/SwiftRefactor/PackageManifest/AddPackageDependency.swift b/Sources/SwiftRefactor/PackageManifest/AddPackageDependency.swift
@@ -15,6 +15,7 @@ import SwiftSyntax
 import SwiftSyntaxBuilder
 
 /// Add a package dependency to a package manifest's source code.
+@_spi(PackageRefactor)
 public struct AddPackageDependency: ManifestEditRefactoringProvider {
   public struct Context {
     public var dependency: PackageDependency
diff --git a/Sources/SwiftRefactor/PackageManifest/AddPackageTarget.swift b/Sources/SwiftRefactor/PackageManifest/AddPackageTarget.swift
@@ -15,6 +15,7 @@ import SwiftSyntax
 import SwiftSyntaxBuilder
 
 /// Add a target to a manifest's source code.
+@_spi(PackageRefactor)
 public struct AddPackageTarget: ManifestEditRefactoringProvider {
   public struct Context {
     public let target: PackageTarget
diff --git a/Sources/SwiftRefactor/PackageManifest/AddPluginUsage.swift b/Sources/SwiftRefactor/PackageManifest/AddPluginUsage.swift
@@ -16,6 +16,7 @@ import SwiftSyntaxBuilder
 
 /// Add a plugin usage to a particular target in the manifest's source
 /// code.
+@_spi(PackageRefactor)
 public struct AddPluginUsage: ManifestEditRefactoringProvider {
   public struct Context {
     public let targetName: String
diff --git a/Sources/SwiftRefactor/PackageManifest/AddProduct.swift b/Sources/SwiftRefactor/PackageManifest/AddProduct.swift
@@ -15,6 +15,7 @@ import SwiftSyntax
 import SwiftSyntaxBuilder
 
 /// Add a product to the manifest's source code.
+@_spi(PackageRefactor)
 public struct AddProduct: ManifestEditRefactoringProvider {
   public struct Context {
     public let product: ProductDescription
diff --git a/Sources/SwiftRefactor/PackageManifest/AddSwiftSetting.swift b/Sources/SwiftRefactor/PackageManifest/AddSwiftSetting.swift
@@ -15,6 +15,7 @@ import SwiftSyntax
 import SwiftSyntaxBuilder
 
 /// Add a swift setting to a manifest's source code.
+@_spi(PackageRefactor)
 public struct AddSwiftSetting: ManifestEditRefactoringProvider {
   public struct Context {
     let target: String
diff --git a/Sources/SwiftRefactor/PackageManifest/AddTargetDependency.swift b/Sources/SwiftRefactor/PackageManifest/AddTargetDependency.swift
@@ -15,6 +15,7 @@ import SwiftSyntax
 import SwiftSyntaxBuilder
 
 /// Add a target dependency to a manifest's source code.
+@_spi(PackageRefactor)
 public struct AddTargetDependency: ManifestEditRefactoringProvider {
   public struct Context {
     /// The dependency to add.
diff --git a/Sources/SwiftRefactor/PackageManifest/ManifestEditError.swift b/Sources/SwiftRefactor/PackageManifest/ManifestEditError.swift
@@ -14,6 +14,7 @@ import SwiftSyntax
 
 /// An error describing problems that can occur when attempting to edit a
 /// package manifest programattically.
+@_spi(PackageRefactor)
 public enum ManifestEditError: Error, Equatable {
   case cannotFindPackage
   case cannotFindTargets
diff --git a/Sources/SwiftRefactor/PackageManifest/ManifestEditRefactoringProvider.swift b/Sources/SwiftRefactor/PackageManifest/ManifestEditRefactoringProvider.swift
@@ -12,6 +12,7 @@
 
 import SwiftSyntax
 
+@_spi(PackageRefactor)
 public protocol ManifestEditRefactoringProvider: EditRefactoringProvider
 where Self.Input == SourceFileSyntax {
 
diff --git a/Sources/SwiftRefactor/PackageManifest/PackageDependency.swift b/Sources/SwiftRefactor/PackageManifest/PackageDependency.swift
@@ -16,6 +16,7 @@ import SwiftSyntaxBuilder
 
 /// Describes a package dependency for refactoring purposes. This is a syntactic
 /// subset of the full package manifest's description of a package dependency.
+@_spi(PackageRefactor)
 public enum PackageDependency: Sendable {
   case fileSystem(FileSystem)
   case sourceControl(SourceControl)
diff --git a/Sources/SwiftRefactor/PackageManifest/PackageEdit.swift b/Sources/SwiftRefactor/PackageManifest/PackageEdit.swift
@@ -14,6 +14,7 @@ import SwiftSyntax
 
 /// The result of editing a package, including any edits to the package
 /// manifest and any new files that are introduced.
+@_spi(PackageRefactor)
 public struct PackageEdit {
   /// Edits to perform to the package manifest.
   public var manifestEdits: [SourceEdit] = []
diff --git a/Sources/SwiftRefactor/PackageManifest/PackageTarget.swift b/Sources/SwiftRefactor/PackageManifest/PackageTarget.swift
@@ -14,6 +14,7 @@ import SwiftSyntax
 
 /// Syntactic wrapper type that describes a target for refactoring
 /// purposes but does not interpret its contents.
+@_spi(PackageRefactor)
 public struct PackageTarget {
   public let name: String
 
diff --git a/Sources/SwiftRefactor/PackageManifest/ProductDescription.swift b/Sources/SwiftRefactor/PackageManifest/ProductDescription.swift
@@ -14,6 +14,7 @@ import SwiftSyntax
 
 /// Syntactic wrapper type that describes a product for refactoring
 /// purposes but does not interpret its contents.
+@_spi(PackageRefactor)
 public struct ProductDescription {
   /// The name of the product.
   public let name: String
diff --git a/Sources/SwiftRefactor/PackageManifest/StringUtils.swift b/Sources/SwiftRefactor/PackageManifest/StringUtils.swift
@@ -10,6 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
+@_spi(PackageRefactor)
 extension String {
   /// Returns a form of the string that is valid C99 Extended Identifier (by
   /// replacing any invalid characters in an unspecified but consistent way).
diff --git a/Sources/SwiftRefactor/PackageManifest/SyntaxEditUtils.swift b/Sources/SwiftRefactor/PackageManifest/SyntaxEditUtils.swift
@@ -18,6 +18,7 @@ import SwiftSyntax
 /// to get it right.
 let defaultIndent = TriviaPiece.spaces(4)
 
+@_spi(PackageRefactor)
 extension Trivia {
   /// Determine whether this trivia has newlines or not.
   var hasNewlines: Bool {
@@ -50,6 +51,7 @@ private class FirstNodeFinder<Node: SyntaxProtocol>: SyntaxAnyVisitor {
   }
 }
 
+@_spi(PackageRefactor)
 extension SyntaxProtocol {
   /// Find the first node of the Self type that matches the given predicate.
   static func findFirst(
@@ -64,6 +66,7 @@ extension SyntaxProtocol {
   }
 }
 
+@_spi(PackageRefactor)
 extension FunctionCallExprSyntax {
   /// Check whether this call expression has a callee that is a reference
   /// to a declaration with the given name.
@@ -86,6 +89,7 @@ extension FunctionCallExprSyntax {
   }
 }
 
+@_spi(PackageRefactor)
 extension LabeledExprListSyntax {
   /// Find the index at which the one would insert a new argument given
   /// the set of argument labels that could come after the argument we
@@ -158,6 +162,7 @@ extension LabeledExprListSyntax {
   }
 }
 
+@_spi(PackageRefactor)
 extension SyntaxProtocol {
   /// Look for a call expression to a callee with the given name.
   func findCall(calleeName: String) -> FunctionCallExprSyntax? {
@@ -167,6 +172,7 @@ extension SyntaxProtocol {
   }
 }
 
+@_spi(PackageRefactor)
 extension FunctionCallExprSyntax {
   /// Find the call that forms a target with the given name in this
   /// package manifest.
@@ -200,6 +206,7 @@ extension FunctionCallExprSyntax {
   }
 }
 
+@_spi(PackageRefactor)
 extension ArrayExprSyntax {
   /// Produce a new array literal expression that appends the given
   /// element, while trying to maintain similar indentation.
@@ -259,6 +266,7 @@ extension ArrayExprSyntax {
   }
 }
 
+@_spi(PackageRefactor)
 extension ExprSyntax {
   /// Find an array argument either at the top level or within a sequence
   /// expression.
@@ -278,6 +286,7 @@ extension ExprSyntax {
 }
 
 // MARK: Utilities to oeprate on arrays of array literal elements.
+@_spi(PackageRefactor)
 extension [ArrayElementSyntax] {
   /// Append a new argument expression.
   mutating func append(expression: ExprSyntax) {
@@ -306,6 +315,7 @@ extension [ArrayElementSyntax] {
 
 // MARK: Utilities to operate on arrays of call arguments.
 
+@_spi(PackageRefactor)
 extension [LabeledExprSyntax] {
   /// Append a potentially labeled argument with the argument expression.
   mutating func append(label: String?, expression: ExprSyntax) {
@@ -430,6 +440,7 @@ private class ReplacingRewriter: SyntaxRewriter {
   }
 }
 
+@_spi(PackageRefactor)
 fileprivate extension SyntaxProtocol {
   /// Replace the given child with a new child node.
   func replacingChild(_ childNode: Syntax, with newChildNode: Syntax) -> Self {
@@ -440,6 +451,7 @@ fileprivate extension SyntaxProtocol {
   }
 }
 
+@_spi(PackageRefactor)
 extension FunctionCallExprSyntax {
   /// Perform source edits that will add the given new element to the
   /// array for an argument with the given label (if there is one), or
diff --git a/Tests/SwiftRefactorTest/ManifestEditTests.swift b/Tests/SwiftRefactorTest/ManifestEditTests.swift
@@ -12,7 +12,7 @@
 
 @_spi(FixItApplier) import SwiftIDEUtils
 import SwiftParser
-import SwiftRefactor
+@_spi(PackageRefactor) import SwiftRefactor
 import SwiftSyntax
 import SwiftSyntaxBuilder
 import XCTest
