1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import PackageLoading
import PackageModel
import SwiftSyntax
/// An error describing problems that can occur when attempting to edit a
/// package manifest programattically.
package enum ManifestEditError: Error {
case cannotFindPackage
case cannotFindTargets
case cannotFindTarget(targetName: String)
case cannotFindArrayLiteralArgument(argumentName: String, node: Syntax)
case oldManifest(ToolsVersion)
}
extension ToolsVersion {
/// The minimum tools version of the manifest file that we support edit
/// operations on.
static let minimumManifestEditVersion = v5_5
}
extension ManifestEditError: CustomStringConvertible {
package var description: String {
switch self {
case .cannotFindPackage:
"invalid manifest: unable to find 'Package' declaration"
case .cannotFindTargets:
"unable to find package targets in manifest"
case .cannotFindTarget(targetName: let name):
"unable to find target named '\(name)' in package"
case .cannotFindArrayLiteralArgument(argumentName: let name, node: _):
"unable to find array literal for '\(name)' argument"
case .oldManifest(let version):
"package manifest version \(version) is too old: please update to manifest version \(ToolsVersion.minimumManifestEditVersion) or newer"
}
}
}
extension SourceFileSyntax {
/// Check that the manifest described by this source file meets the minimum
/// tools version requirements for editing the manifest.
func checkEditManifestToolsVersion() throws {
let toolsVersion = try ToolsVersionParser.parse(utf8String: description)
if toolsVersion < ToolsVersion.minimumManifestEditVersion {
throw ManifestEditError.oldManifest(toolsVersion)
}
}
}
|