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 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2018-2021 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
//
//===----------------------------------------------------------------------===//
@_implementationOnly import Foundation
/// The basic building block of a Swift package.
///
/// Each target contains a set of source files that Swift Package Manager compiles into a module
/// or test suite. You can vend targets to other packages by defining products
/// that include the targets.
///
/// A target may depend on other targets within the same package and on products
/// vended by the package's dependencies.
public final class Target {
/// The different types of a target.
public enum TargetType: String {
/// A target that contains code for the Swift package's functionality.
case regular
/// A target that contains code for an executable's main module.
case executable
/// A target that contains tests for the Swift package's other targets.
case test
/// A target that adapts a library on the system to work with Swift
/// packages.
case system
/// A target that references a binary artifact.
case binary
/// A target that provides a package plug-in.
case plugin
/// A target that provides a Swift macro.
case `macro`
}
/// The different types of a target's dependency on another entity.
public enum Dependency {
/// A dependency on a target.
///
/// - Parameters:
/// - name: The name of the target.
/// - condition: A condition that limits the application of the target dependency. For example, only apply a dependency for a specific platform.
case targetItem(name: String, condition: TargetDependencyCondition?)
/// A dependency on a product.
///
/// - Parameters:
/// - name: The name of the product.
/// - package: The name of the package.
/// - moduleAlias: The module aliases for targets in the product.
/// - condition: A condition that limits the application of the target dependency. For example, only apply a dependency for a specific platform.
case productItem(name: String, package: String?, moduleAliases: [String: String]?, condition: TargetDependencyCondition?)
/// A by-name dependency on either a target or a product.
///
/// - Parameters:
/// - name: The name of the dependency, either a target or a product.
/// - condition: A condition that limits the application of the target
/// dependency. For example, only apply a dependency for a specific
/// platform.
case byNameItem(name: String, condition: TargetDependencyCondition?)
}
/// The name of the target.
public var name: String
/// The path of the target, relative to the package root.
///
/// If the path is `nil`, Swift Package Manager looks for a target's source files at
/// predefined search paths and in a subdirectory with the target's name.
///
/// The predefined search paths are the following directories under the
/// package root:
///
/// - `Sources`, `Source`, `src`, and `srcs` for regular targets
/// - `Tests`, `Sources`, `Source`, `src`, and `srcs` for test targets
///
/// For example, Swift Package Manager looks for source files inside the
/// `[PackageRoot]/Sources/[TargetName]` directory.
///
/// Don't escape the package root; that is, values like `../Foo` or `/Foo`
/// are invalid.
public var path: String?
/// The URL of a binary target.
///
/// The URL points to an archive file that contains the referenced binary
/// artifact at its root.
///
/// Binary targets are only available on Apple platforms.
@available(_PackageDescription, introduced: 5.3)
public var url: String?
/// The source files in this target.
///
/// If this property is `nil`, Swift Package Manager includes all valid source files in the
/// target's path and treats specified paths as relative to the target's
/// path.
///
/// A path can be a path to a directory or an individual source file. In
/// case of a directory, Swift Package Manager searches for valid source files recursively
/// inside it.
public var sources: [String]?
/// The explicit list of resource files in the target.
@available(_PackageDescription, introduced: 5.3)
public var resources: [Resource]?
/// The paths to source and resource files that you don't want to include in the target.
///
/// Excluded paths are relative to the target path. This property has
/// precedence over the `sources` and `resources` properties.
public var exclude: [String]
/// A Boolean value that indicates whether this is a test target.
public var isTest: Bool {
return type == .test
}
/// The target's dependencies on other entities inside or outside the package.
public var dependencies: [Dependency]
/// The path to the directory that contains public headers of a C-family target.
///
/// If this is `nil`, the directory is set to `include`.
public var publicHeadersPath: String?
/// The type of the target.
public let type: TargetType
/// If true, access to package declarations from other targets in the package is allowed.
public let packageAccess: Bool
/// The name of the package configuration file, without extension, for the system library target.
///
/// If present, the Swift Package Manager tries every package configuration
/// name separated by a space to search for the `<name>.pc` file
/// to get the additional flags needed for the system library target.
public let pkgConfig: String?
/// The providers array for a system library target.
public let providers: [SystemPackageProvider]?
/// The capability provided by a package plug-in target.
@available(_PackageDescription, introduced: 5.5)
public var pluginCapability: PluginCapability?
/// The different types of capability that a plug-in can provide.
///
/// In this version of SwiftPM, only build tool and command plug-ins are supported;
/// this enumeration will be extended as new plug-in capabilities are added.
public enum PluginCapability {
/// Specifies that the plug-in provides a build tool capability.
///
/// The plug-in to apply to each target that uses it, and creates commands
/// that run before or during the build of the target.
@available(_PackageDescription, introduced: 5.5)
case buildTool
/// Specifies that the plug-in provides a user command capability.
///
///- Parameters:
/// - intent: The semantic intent of the plug-in; either one of the predefined intents,
/// or a custom intent.
/// - permissions: Any permissions needed by the command plug-in. This affects what the
/// sandbox in which the plug-in is run allows. Some permissions may require
/// user approval.
///
/// Plug-ins that specify a `command` capability define commands that can run
/// using the SwiftPM command line interface, or in an IDE that supports
/// Swift packages. You can invoke the command manually on one or more targets in a package.
///
///```swift
///swift package <verb>
///```
///
/// The package can specify the _verb_ used to invoke the command.
@available(_PackageDescription, introduced: 5.6)
case command(intent: PluginCommandIntent, permissions: [PluginPermission] = [])
}
/// The target's C build settings.
@available(_PackageDescription, introduced: 5)
public var cSettings: [CSetting]?
/// The target's C++ build settings.
@available(_PackageDescription, introduced: 5)
public var cxxSettings: [CXXSetting]?
/// The target's Swift build settings.
@available(_PackageDescription, introduced: 5)
public var swiftSettings: [SwiftSetting]?
/// The target's linker settings.
@available(_PackageDescription, introduced: 5)
public var linkerSettings: [LinkerSetting]?
/// The checksum for the archive file that contains the referenced binary
/// artifact.
///
/// If you make a remote binary framework available as a Swift package,
/// declare a remote, or _URL-based_, binary target in your package manifest
/// with ``Target/binaryTarget(name:url:checksum:)``. Always run `swift
/// package compute-checksum path/to/MyFramework.zip` at the command line to
/// make sure you create a correct SHA256 checksum.
///
/// For more information, see
/// <doc:distributing-binary-frameworks-as-swift-packages>.
@available(_PackageDescription, introduced: 5.3)
public var checksum: String?
/// The uses of package plug-ins by the target.
@available(_PackageDescription, introduced: 5.5)
public var plugins: [PluginUsage]?
/// A plug-in used in a target.
@available(_PackageDescription, introduced: 5.5)
public enum PluginUsage {
/// Specifies the use of a plug-in product in a package dependency.
///
/// - Parameters:
/// - name: The name of the plug-in target.
/// - package: The name of the package that defines the plug-in target.
case plugin(name: String, package: String?)
}
/// Construct a target.
@_spi(PackageDescriptionInternal)
public init(
name: String,
dependencies: [Dependency],
path: String?,
url: String? = nil,
exclude: [String],
sources: [String]?,
resources: [Resource]? = nil,
publicHeadersPath: String?,
type: TargetType,
packageAccess: Bool,
pkgConfig: String? = nil,
providers: [SystemPackageProvider]? = nil,
pluginCapability: PluginCapability? = nil,
cSettings: [CSetting]? = nil,
cxxSettings: [CXXSetting]? = nil,
swiftSettings: [SwiftSetting]? = nil,
linkerSettings: [LinkerSetting]? = nil,
checksum: String? = nil,
plugins: [PluginUsage]? = nil
) {
self.name = name
self.dependencies = dependencies
self.path = path
self.url = url
self.publicHeadersPath = publicHeadersPath
self.sources = sources
self.resources = resources
self.exclude = exclude
self.type = type
self.packageAccess = packageAccess
self.pkgConfig = pkgConfig
self.providers = providers
self.pluginCapability = pluginCapability
self.cSettings = cSettings
self.cxxSettings = cxxSettings
self.swiftSettings = swiftSettings
self.linkerSettings = linkerSettings
self.checksum = checksum
self.plugins = plugins
switch type {
case .regular, .executable, .test:
precondition(
url == nil &&
pkgConfig == nil &&
providers == nil &&
pluginCapability == nil &&
checksum == nil
)
case .system:
precondition(
url == nil &&
dependencies.isEmpty &&
exclude.isEmpty &&
sources == nil &&
resources == nil &&
publicHeadersPath == nil &&
pluginCapability == nil &&
cSettings == nil &&
cxxSettings == nil &&
swiftSettings == nil &&
linkerSettings == nil &&
checksum == nil &&
plugins == nil
)
case .binary:
precondition(
dependencies.isEmpty &&
exclude.isEmpty &&
sources == nil &&
resources == nil &&
publicHeadersPath == nil &&
pkgConfig == nil &&
providers == nil &&
pluginCapability == nil &&
cSettings == nil &&
cxxSettings == nil &&
swiftSettings == nil &&
linkerSettings == nil &&
plugins == nil
)
case .plugin:
precondition(
url == nil &&
resources == nil &&
publicHeadersPath == nil &&
pkgConfig == nil &&
providers == nil &&
pluginCapability != nil &&
cSettings == nil &&
cxxSettings == nil &&
swiftSettings == nil &&
linkerSettings == nil &&
plugins == nil
)
case .macro:
precondition(
url == nil &&
resources == nil &&
publicHeadersPath == nil &&
pkgConfig == nil &&
providers == nil &&
pluginCapability == nil &&
cSettings == nil &&
cxxSettings == nil
)
}
}
/// Creates a library or executable target.
///
/// A target can contain either Swift or C-family source files, but not both. The Swift Package Manager
/// considers a target to be an executable target if its directory contains a `main.swift`, `main.m`, `main.c`,
/// or `main.cpp` file. The Swift Package Manager considers all other targets to be library targets.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, the Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that the Swift Package Manager shouldn't consider to be source or resource files.
/// A path is relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// the Swift Package Manager searches for valid source files recursively.
/// - publicHeadersPath: The directory containing public headers of a C-family library target.
@available(_PackageDescription, introduced: 4, obsoleted: 5)
public static func target(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
publicHeadersPath: String? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
publicHeadersPath: publicHeadersPath,
type: .regular,
packageAccess: false
)
}
/// Creates a library or executable target.
///
/// A target can contain either Swift or C-family source files, but not both. The Swift Package Manager
/// considers a target to be an executable target if its directory contains a `main.swift`, `main.m`, `main.c`,
/// or `main.cpp` file. The Swift Package Manager considers all other targets to be library targets.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, the Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that the Swift Package Manager shouldn't consider to be source or resource files.
/// Paths are relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// the Swift Package Manager searches for valid source files recursively.
/// - publicHeadersPath: The directory containing public headers of a C-family library target.
/// - cSettings: The C settings for this target.
/// - cxxSettings: The C++ settings for this target.
/// - swiftSettings: The Swift settings for this target.
/// - linkerSettings: The linker settings for this target.
@available(_PackageDescription, introduced: 5, obsoleted: 5.3)
public static func target(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
publicHeadersPath: String? = nil,
cSettings: [CSetting]? = nil,
cxxSettings: [CXXSetting]? = nil,
swiftSettings: [SwiftSetting]? = nil,
linkerSettings: [LinkerSetting]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
publicHeadersPath: publicHeadersPath,
type: .regular,
packageAccess: false,
cSettings: cSettings,
cxxSettings: cxxSettings,
swiftSettings: swiftSettings,
linkerSettings: linkerSettings
)
}
/// Creates a regular target.
///
/// A target can contain either Swift or C-family source files, but not both. It contains code that is built as
/// a regular module that can be included in a library or executable product, but that cannot itself be used as
/// the main target of an executable product.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, the Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that the Swift Package Manager shouldn't consider to be source or resource files.
/// A path is relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// the Swift Package Manager searches for valid source files recursively.
/// - resources: An explicit list of resources files.
/// - publicHeadersPath: The directory containing public headers of a C-family library target.
/// - cSettings: The C settings for this target.
/// - cxxSettings: The C++ settings for this target.
/// - swiftSettings: The Swift settings for this target.
/// - linkerSettings: The linker settings for this target.
@available(_PackageDescription, introduced: 5.3, obsoleted: 5.5)
public static func target(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
resources: [Resource]? = nil,
publicHeadersPath: String? = nil,
cSettings: [CSetting]? = nil,
cxxSettings: [CXXSetting]? = nil,
swiftSettings: [SwiftSetting]? = nil,
linkerSettings: [LinkerSetting]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
resources: resources,
publicHeadersPath: publicHeadersPath,
type: .regular,
packageAccess: false,
cSettings: cSettings,
cxxSettings: cxxSettings,
swiftSettings: swiftSettings,
linkerSettings: linkerSettings
)
}
/// Creates a regular target.
///
/// A target can contain either Swift or C-family source files, but not both. It contains code that is built as
/// a regular module that can be included in a library or executable product, but that cannot itself be used as
/// the main target of an executable product.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, the Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that the Swift Package Manager shouldn't consider to be source or resource files.
/// A path is relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// the Swift Package Manager searches for valid source files recursively.
/// - resources: An explicit list of resources files.
/// - publicHeadersPath: The directory containing public headers of a C-family library target.
/// - cSettings: The C settings for this target.
/// - cxxSettings: The C++ settings for this target.
/// - swiftSettings: The Swift settings for this target.
/// - linkerSettings: The linker settings for this target.
/// - plugins: The plug-ins used by this target.
@available(_PackageDescription, introduced: 5.5, obsoleted: 5.9)
public static func target(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
resources: [Resource]? = nil,
publicHeadersPath: String? = nil,
cSettings: [CSetting]? = nil,
cxxSettings: [CXXSetting]? = nil,
swiftSettings: [SwiftSetting]? = nil,
linkerSettings: [LinkerSetting]? = nil,
plugins: [PluginUsage]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
resources: resources,
publicHeadersPath: publicHeadersPath,
type: .regular,
packageAccess: false,
cSettings: cSettings,
cxxSettings: cxxSettings,
swiftSettings: swiftSettings,
linkerSettings: linkerSettings,
plugins: plugins
)
}
/// Creates a regular target.
///
/// A target can contain either Swift or C-family source files, but not both. It contains code that is built as
/// a regular module for inclusion in a library or executable product, but that cannot itself be used as
/// the main target of an executable product.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, the Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that the Swift Package Manager shouldn't consider to be source or resource files.
/// A path is relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// Swift Package Manager searches for valid source files recursively.
/// - resources: An explicit list of resources files.
/// - publicHeadersPath: The directory that contains public headers of a C-family library target.
/// - packageAccess: Allows package symbols from other targets in the package.
/// - cSettings: The C settings for this target.
/// - cxxSettings: The C++ settings for this target.
/// - swiftSettings: The Swift settings for this target.
/// - linkerSettings: The linker settings for this target.
/// - plugins: The plug-ins used by this target
@available(_PackageDescription, introduced: 5.9)
public static func target(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
resources: [Resource]? = nil,
publicHeadersPath: String? = nil,
packageAccess: Bool = true,
cSettings: [CSetting]? = nil,
cxxSettings: [CXXSetting]? = nil,
swiftSettings: [SwiftSetting]? = nil,
linkerSettings: [LinkerSetting]? = nil,
plugins: [PluginUsage]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
resources: resources,
publicHeadersPath: publicHeadersPath,
type: .regular,
packageAccess: packageAccess,
cSettings: cSettings,
cxxSettings: cxxSettings,
swiftSettings: swiftSettings,
linkerSettings: linkerSettings,
plugins: plugins
)
}
/// Creates an executable target.
///
/// An executable target can contain either Swift or C-family source files, but not both. It contains code that
/// is built as an executable module that can be used as the main target of an executable product. The target
/// is expected to either have a source file named `main.swift`, `main.m`, `main.c`, or `main.cpp`, or a source
/// file that contains the `@main` keyword.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, the Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that the Swift Package Manager shouldn't consider to be source or resource files.
/// A path is relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// the Swift Package Manager searches for valid source files recursively.
/// - resources: An explicit list of resources files.
/// - publicHeadersPath: The directory containing public headers of a C-family library target.
/// - cSettings: The C settings for this target.
/// - cxxSettings: The C++ settings for this target.
/// - swiftSettings: The Swift settings for this target.
/// - linkerSettings: The linker settings for this target.
@available(_PackageDescription, introduced: 5.4, obsoleted: 5.5)
public static func executableTarget(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
resources: [Resource]? = nil,
publicHeadersPath: String? = nil,
cSettings: [CSetting]? = nil,
cxxSettings: [CXXSetting]? = nil,
swiftSettings: [SwiftSetting]? = nil,
linkerSettings: [LinkerSetting]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
resources: resources,
publicHeadersPath: publicHeadersPath,
type: .executable,
packageAccess: false,
cSettings: cSettings,
cxxSettings: cxxSettings,
swiftSettings: swiftSettings,
linkerSettings: linkerSettings
)
}
/// Creates an executable target.
///
/// An executable target can contain either Swift or C-family source files, but not both. It contains code that
/// is built as an executable module that can be used as the main target of an executable product. The target
/// is expected to either have a source file named `main.swift`, `main.m`, `main.c`, or `main.cpp`, or a source
/// file that contains the `@main` keyword.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, the Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that the Swift Package Manager shouldn't consider to be source or resource files.
/// A path is relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// the Swift Package Manager searches for valid source files recursively.
/// - resources: An explicit list of resources files.
/// - publicHeadersPath: The directory containing public headers of a C-family library target.
/// - cSettings: The C settings for this target.
/// - cxxSettings: The C++ settings for this target.
/// - swiftSettings: The Swift settings for this target.
/// - linkerSettings: The linker settings for this target.
/// - plugins: The plug-ins used by this target.
@available(_PackageDescription, introduced: 5.5, obsoleted: 5.9)
public static func executableTarget(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
resources: [Resource]? = nil,
publicHeadersPath: String? = nil,
cSettings: [CSetting]? = nil,
cxxSettings: [CXXSetting]? = nil,
swiftSettings: [SwiftSetting]? = nil,
linkerSettings: [LinkerSetting]? = nil,
plugins: [PluginUsage]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
resources: resources,
publicHeadersPath: publicHeadersPath,
type: .executable,
packageAccess: false,
cSettings: cSettings,
cxxSettings: cxxSettings,
swiftSettings: swiftSettings,
linkerSettings: linkerSettings,
plugins: plugins
)
}
/// Creates an executable target.
///
/// An executable target can contain either Swift or C-family source files, but not both. It contains code that
/// is built as an executable module for use as the main target of an executable product. The target
/// is expected to either have a source file named `main.swift`, `main.m`, `main.c`, or `main.cpp`, or a source
/// file that contains the `@main` keyword.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that Swift Package Manager shouldn't consider to be source or resource files.
/// A path is relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// Swift Package Manager searches for valid source files recursively.
/// - resources: An explicit list of resources files.
/// - publicHeadersPath: The directory that contains public headers of a C-family library target.
/// - packageAccess: Allows package symbols from other targets in the package.
/// - cSettings: The C settings for this target.
/// - cxxSettings: The C++ settings for this target.
/// - swiftSettings: The Swift settings for this target.
/// - linkerSettings: The linker settings for this target.
/// - plugins: The plug-ins used by this target
@available(_PackageDescription, introduced: 5.9)
public static func executableTarget(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
resources: [Resource]? = nil,
publicHeadersPath: String? = nil,
packageAccess: Bool = true,
cSettings: [CSetting]? = nil,
cxxSettings: [CXXSetting]? = nil,
swiftSettings: [SwiftSetting]? = nil,
linkerSettings: [LinkerSetting]? = nil,
plugins: [PluginUsage]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
resources: resources,
publicHeadersPath: publicHeadersPath,
type: .executable,
packageAccess: packageAccess,
cSettings: cSettings,
cxxSettings: cxxSettings,
swiftSettings: swiftSettings,
linkerSettings: linkerSettings,
plugins: plugins
)
}
/// Creates a test target.
///
/// Write test targets using the XCTest testing framework.
/// Test targets generally declare a dependency on the targets they test.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, the Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that the Swift Package Manager shouldn't consider to be source or resource files.
/// A path is relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// the Swift Package Manager searches for valid source files recursively.
@available(_PackageDescription, introduced: 4, obsoleted: 5)
public static func testTarget(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
publicHeadersPath: nil,
type: .test,
packageAccess: false
)
}
/// Creates a test target.
///
/// Write test targets using the XCTest testing framework.
/// Test targets generally declare a dependency on the targets they test.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, the Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that the Swift Package Manager shouldn't consider to be source or resource files.
/// A path is relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// the Swift Package Manager searches for valid source files recursively.
/// - cSettings: The C settings for this target.
/// - cxxSettings: The C++ settings for this target.
/// - swiftSettings: The Swift settings for this target.
/// - linkerSettings: The linker settings for this target.
@available(_PackageDescription, introduced: 5, obsoleted: 5.3)
public static func testTarget(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
cSettings: [CSetting]? = nil,
cxxSettings: [CXXSetting]? = nil,
swiftSettings: [SwiftSetting]? = nil,
linkerSettings: [LinkerSetting]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
publicHeadersPath: nil,
type: .test,
packageAccess: false,
cSettings: cSettings,
cxxSettings: cxxSettings,
swiftSettings: swiftSettings,
linkerSettings: linkerSettings
)
}
/// Creates a test target.
///
/// Write test targets using the XCTest testing framework.
/// Test targets generally declare a dependency on the targets they test.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, the Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that the Swift Package Manager shouldn't consider to be source or resource files.
/// A path is relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// the Swift Package Manager searches for valid source files recursively.
/// - resources: An explicit list of resources files.
/// - cSettings: The C settings for this target.
/// - cxxSettings: The C++ settings for this target.
/// - swiftSettings: The Swift settings for this target.
/// - linkerSettings: The linker settings for this target.
@available(_PackageDescription, introduced: 5.3, obsoleted: 5.5)
public static func testTarget(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
resources: [Resource]? = nil,
cSettings: [CSetting]? = nil,
cxxSettings: [CXXSetting]? = nil,
swiftSettings: [SwiftSetting]? = nil,
linkerSettings: [LinkerSetting]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
resources: resources,
publicHeadersPath: nil,
type: .test,
packageAccess: false,
cSettings: cSettings,
cxxSettings: cxxSettings,
swiftSettings: swiftSettings,
linkerSettings: linkerSettings
)
}
/// Creates a test target.
///
/// Write test targets using the XCTest testing framework.
/// Test targets generally declare a dependency on the targets they test.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, the Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that the Swift Package Manager shouldn't consider to be source or resource files.
/// A path is relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// the Swift Package Manager searches for valid source files recursively.
/// - resources: An explicit list of resources files.
/// - cSettings: The C settings for this target.
/// - cxxSettings: The C++ settings for this target.
/// - swiftSettings: The Swift settings for this target.
/// - linkerSettings: The linker settings for this target.
/// - plugins: The plug-ins used by this target.
@available(_PackageDescription, introduced: 5.5, obsoleted: 5.9)
public static func testTarget(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
resources: [Resource]? = nil,
cSettings: [CSetting]? = nil,
cxxSettings: [CXXSetting]? = nil,
swiftSettings: [SwiftSetting]? = nil,
linkerSettings: [LinkerSetting]? = nil,
plugins: [PluginUsage]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
resources: resources,
publicHeadersPath: nil,
type: .test,
packageAccess: false,
cSettings: cSettings,
cxxSettings: cxxSettings,
swiftSettings: swiftSettings,
linkerSettings: linkerSettings,
plugins: plugins
)
}
/// Creates a test target.
///
/// Write test targets using the XCTest testing framework.
/// Test targets generally declare a dependency on the targets they test.
///
/// - Parameters:
/// - name: The name of the target.
/// - dependencies: The dependencies of the target. A dependency can be another target in the package or a product from a package dependency.
/// - path: The custom path for the target. By default, Swift Package Manager requires a target's sources to reside at predefined search paths;
/// for example, `[PackageRoot]/Sources/[TargetName]`.
/// Don't escape the package root; for example, values like `../Foo` or `/Foo` are invalid.
/// - exclude: A list of paths to files or directories that Swift Package Manager shouldn't consider to be source or resource files.
/// A path is relative to the target's directory.
/// This parameter has precedence over the ``sources`` parameter.
/// - sources: An explicit list of source files. If you provide a path to a directory,
/// Swift Package Manager searches for valid source files recursively.
/// - resources: An explicit list of resources files.
/// - packageAccess: Allows access to package symbols from other targets in the package.
/// - cSettings: The C settings for this target.
/// - cxxSettings: The C++ settings for this target.
/// - swiftSettings: The Swift settings for this target.
/// - linkerSettings: The linker settings for this target.
/// - plugins: The plug-ins used by this target.
@available(_PackageDescription, introduced: 5.9)
public static func testTarget(
name: String,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
resources: [Resource]? = nil,
packageAccess: Bool = true,
cSettings: [CSetting]? = nil,
cxxSettings: [CXXSetting]? = nil,
swiftSettings: [SwiftSetting]? = nil,
linkerSettings: [LinkerSetting]? = nil,
plugins: [PluginUsage]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
resources: resources,
publicHeadersPath: nil,
type: .test,
packageAccess: packageAccess,
cSettings: cSettings,
cxxSettings: cxxSettings,
swiftSettings: swiftSettings,
linkerSettings: linkerSettings,
plugins: plugins
)
}
/// Creates a system library target.
///
/// Use system library targets to adapt a library installed on the system to
/// work with Swift packages. Such libraries are generally installed by
/// system package managers (such as Homebrew and apt-get) and exposed to
/// Swift packages by providing a `modulemap` file along with other metadata
/// such as the library's `pkgConfig` name.
///
/// - Parameters:
/// - name: The name of the target.
/// - path: The custom path for the target. By default, a targets sources
/// are expected to be located in the predefined search paths, such as
/// `[PackageRoot]/Sources/[TargetName]`. Do not escape the package root;
/// that is, values like `../Foo` or `/Foo` are invalid.
/// - pkgConfig: The name of the `pkg-config` file for this system library.
/// - providers: The providers for this system library.
public static func systemLibrary(
name: String,
path: String? = nil,
pkgConfig: String? = nil,
providers: [SystemPackageProvider]? = nil
) -> Target {
return Target(
name: name,
dependencies: [],
path: path,
exclude: [],
sources: nil,
publicHeadersPath: nil,
type: .system,
packageAccess: false,
pkgConfig: pkgConfig,
providers: providers)
}
/// Creates a binary target that references a remote artifact.
///
/// Binary targets are only available on Apple platforms.
///
/// - Parameters:
/// - name: The name of the target.
/// - url: The URL to the binary artifact. This URL must point to an archive
/// file that contains a binary artifact in its root directory.
/// - checksum: The checksum of the archive file that contains the binary
/// artifact.
@available(_PackageDescription, introduced: 5.3)
public static func binaryTarget(
name: String,
url: String,
checksum: String
) -> Target {
return Target(
name: name,
dependencies: [],
path: nil,
url: url,
exclude: [],
sources: nil,
publicHeadersPath: nil,
type: .binary,
packageAccess: false,
checksum: checksum)
}
/// Creates a binary target that references an artifact on disk.
///
/// Binary targets are only available on Apple platforms.
///
/// - Parameters:
/// - name: The name of the target.
/// - path: The path to the binary artifact. This path can point directly to
/// a binary artifact or to an archive file that contains the binary
/// artifact at its root.
@available(_PackageDescription, introduced: 5.3)
public static func binaryTarget(
name: String,
path: String
) -> Target {
return Target(
name: name,
dependencies: [],
path: path,
exclude: [],
sources: nil,
publicHeadersPath: nil,
type: .binary,
packageAccess: false)
}
/// Defines a new package plugin target.
///
/// A plugin target provides custom build commands to SwiftPM (and to
/// any IDEs based on libSwiftPM).
///
/// The capability determines what kind of build commands it can add. Besides
/// determining at what point in the build those commands run, the capability
/// determines the context that is available to the plugin and the kinds of
/// commands it can create.
///
/// In the initial version of this proposal, three capabilities are provided:
/// prebuild, build tool, and postbuild. See the declaration of each capability
/// under ``PluginCapability-swift.enum`` for more information.
///
/// The package plugin itself is implemented using a Swift script that is
/// invoked for each target that uses it. The script is invoked after the
/// package graph has been resolved, but before the build system creates its
/// dependency graph. It is also invoked after changes to the target or the
/// build parameters.
///
/// Note that the role of the package plugin is only to define the commands
/// that will run before, during, or after the build. It does not itself run
/// those commands. The commands are defined in an IDE-neutral way, and are
/// run as appropriate by the build system that builds the package. The extension
/// itself is only a procedural way of generating commands and their input
/// and output dependencies.
///
/// The package plugin may specify the executable targets or binary targets
/// that provide the build tools that will be used by the generated commands
/// during the build. In the initial implementation, prebuild actions can only
/// depend on binary targets. Build tool and postbuild plugins can depend
/// on executables as well as binary targets. This is due to how
/// Swift Package Manager constructs its build plan.
///
/// - Parameters:
/// - name: The name of the plugin target.
/// - capability: The type of capability the plugin target provides.
/// - dependencies: The plugin target's dependencies.
/// - path: The path of the plugin target, relative to the package root.
/// - exclude: The paths to source and resource files that you want to exclude from the plug-in target.
/// - sources: The source files in the plug-in target.
/// - Returns: A `Target` instance.
@available(_PackageDescription, introduced: 5.5, obsoleted: 5.9)
public static func plugin(
name: String,
capability: PluginCapability,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
publicHeadersPath: nil,
type: .plugin,
packageAccess: false,
pluginCapability: capability)
}
/// Defines a new package plug-in target.
///
/// A plug-in target provides custom build commands to SwiftPM (and to
/// any IDEs based on libSwiftPM).
///
/// The capability determines what kind of build commands it can add. Besides
/// determining at what point in the build those commands run, the capability
/// determines the context that is available to the plug-in and the kinds of
/// commands it can create.
///
/// In the initial version of this proposal, three capabilities are provided:
/// prebuild, build tool, and postbuild. For more information, see the declaration of each capability
/// under ``PluginCapability-swift.enum``.
///
/// The package plug-in itself is implemented using a Swift script that is
/// invoked for each target that uses it. The script is invoked after the
/// package graph has been resolved, but before the build system creates its
/// dependency graph. It's also invoked after changes to the target or the
/// build parameters.
///
/// Note that the role of the package plug-in is only to define the commands
/// that run before, during, or after the build. It doesn't run
/// those commands itself. The commands are defined in an IDE-neutral way, and are
/// run as appropriate by the build system that builds the package. The extension
/// itself is only a procedural way of generating commands and their input
/// and output dependencies.
///
/// The package plug-in may specify the executable or binary targets
/// that provide the build tools used by the generated commands
/// during the build. In the initial implementation, prebuild actions can only
/// depend on binary targets. Build tool and postbuild plug-ins can depend
/// on executables as well as binary targets. This is due to how
/// Swift Package Manager constructs its build plan.
///
/// - Parameters:
/// - name: The name of the plug-in target.
/// - capability: The type of capability the plug-in target provides.
/// - dependencies: The plug-in target's dependencies.
/// - path: The path of the plug-in target relative to the package root.
/// - exclude: The paths to source and resource files that you want to exclude from the plug-in target.
/// - sources: The source files in the plug-in target.
/// - packageAccess: Allows access to package symbols from other targets in the package.
/// - Returns: A `Target` instance.
@available(_PackageDescription, introduced: 5.9)
public static func plugin(
name: String,
capability: PluginCapability,
dependencies: [Dependency] = [],
path: String? = nil,
exclude: [String] = [],
sources: [String]? = nil,
packageAccess: Bool = true
) -> Target {
return Target(
name: name,
dependencies: dependencies,
path: path,
exclude: exclude,
sources: sources,
publicHeadersPath: nil,
type: .plugin,
packageAccess: packageAccess,
pluginCapability: capability)
}
}
extension Target.Dependency {
@available(_PackageDescription, obsoleted: 5.7, message: "use .product(name:package:condition) instead.")
public static func productItem(name: String, package: String? = nil, condition: TargetDependencyCondition? = nil) -> Target.Dependency {
return .productItem(name: name, package: package, moduleAliases: nil, condition: nil)
}
/// Creates a dependency on a target in the same package.
///
/// - Parameter name: The name of the target.
/// - Returns: A `Target.Dependency` instance.
@available(_PackageDescription, obsoleted: 5.3)
public static func target(name: String) -> Target.Dependency {
return .targetItem(name: name, condition: nil)
}
/// Creates a dependency on a product from a package dependency.
///
/// - Parameters:
/// - name: The name of the product.
/// - package: The name of the package.
/// - Returns: A `Target.Dependency` instance.
@available(_PackageDescription, obsoleted: 5.2, message: "the 'package' argument is mandatory as of tools version 5.2")
public static func product(name: String, package: String? = nil) -> Target.Dependency {
return .productItem(name: name, package: package, moduleAliases: nil, condition: nil)
}
/// Creates a dependency that resolves to either a target or a product with the specified name.
///
/// - Parameter name: The name of the dependency, either a target or a product.
/// - Returns: A `Target.Dependency` instance.
/// The Swift Package Manager creates the by-name dependency after it has loaded the package graph.
@available(_PackageDescription, obsoleted: 5.3)
public static func byName(name: String) -> Target.Dependency {
return .byNameItem(name: name, condition: nil)
}
/// Creates a dependency on a product from a package dependency.
///
/// - Parameters:
/// - name: The name of the product.
/// - package: The name of the package.
/// - Returns: A `Target.Dependency` instance.
@available(_PackageDescription, introduced: 5.2, obsoleted: 5.3)
public static func product(
name: String,
package: String
) -> Target.Dependency {
return .productItem(name: name, package: package, moduleAliases: nil, condition: nil)
}
/// Creates a dependency on a target in the same package.
///
/// - Parameters:
/// - name: The name of the target.
/// - condition: A condition that limits the application of the target
/// dependency. For example, only apply a dependency for a specific
/// platform.
/// - Returns: A `Target.Dependency` instance.
@available(_PackageDescription, introduced: 5.3)
public static func target(name: String, condition: TargetDependencyCondition? = nil) -> Target.Dependency {
return .targetItem(name: name, condition: condition)
}
/// Creates a target dependency on a product from a package dependency.
///
/// - Parameters:
/// - name: The name of the product.
/// - package: The name of the package.
/// - condition: A condition that limits the application of the target
/// dependency. For example, only apply a dependency for a specific
/// platform.
/// - Returns: A `Target.Dependency` instance.
@_disfavoredOverload
@available(_PackageDescription, introduced: 5.3, obsoleted: 5.7)
public static func product(
name: String,
package: String,
condition: TargetDependencyCondition? = nil
) -> Target.Dependency {
return .productItem(name: name, package: package, moduleAliases: nil, condition: condition)
}
/// Creates a target dependency on a product from a package dependency.
///
/// - Parameters:
/// - name: The name of the product.
/// - package: The name of the package.
/// - moduleAliases: The module aliases for targets in the product.
/// - condition: A condition that limits the application of the target dependency. For example, only apply a
/// dependency for a specific platform.
/// - Returns: A `Target.Dependency` instance.
@available(_PackageDescription, introduced: 5.7)
public static func product(
name: String,
package: String,
moduleAliases: [String: String]? = nil,
condition: TargetDependencyCondition? = nil
) -> Target.Dependency {
return .productItem(name: name, package: package, moduleAliases: moduleAliases, condition: condition)
}
/// Creates a dependency that resolves to either a target or a product with
/// the specified name.
///
/// Swift Package Manager creates the by-name dependency after it has loaded the package
/// graph.
///
/// - Parameters:
/// - name: The name of the dependency, either a target or a product.
/// - condition: A condition that limits the application of the target
/// dependency. For example, only apply a dependency for a specific
/// platform.
/// - Returns: A `Target.Dependency` instance.
@available(_PackageDescription, introduced: 5.3)
public static func byName(name: String, condition: TargetDependencyCondition? = nil) -> Target.Dependency {
return .byNameItem(name: name, condition: condition)
}
}
/// A condition that limits the application of a target's dependency.
public struct TargetDependencyCondition {
let platforms: [Platform]?
private init(platforms: [Platform]?) {
self.platforms = platforms
}
/// Creates a target dependency condition.
///
/// - Parameter platforms: The applicable platforms for this target dependency condition.
@_disfavoredOverload
@available(_PackageDescription, obsoleted: 5.7, message: "using .when with nil platforms is obsolete")
public static func when(
platforms: [Platform]? = nil
) -> TargetDependencyCondition {
// FIXME: This should be an error, not a precondition.
precondition(!(platforms == nil))
return TargetDependencyCondition(platforms: platforms)
}
/// Creates a target dependency condition.
///
/// - Parameter platforms: The applicable platforms for this target dependency condition.
@available(_PackageDescription, introduced: 5.7)
public static func when(
platforms: [Platform]
) -> TargetDependencyCondition? {
return !platforms.isEmpty ? TargetDependencyCondition(platforms: platforms) : .none
}
}
extension Target.PluginCapability {
/// The plug-in is a build tool.
///
/// The plug-in to apply to each target that uses it, and creates commands
/// that run before or during the build of the target.
///
/// - Returns: A plug-in capability that defines a build tool.
@available(_PackageDescription, introduced: 5.5)
public static func buildTool() -> Target.PluginCapability {
return .buildTool
}
}
/// The intended use case of the command plug-in.
@available(_PackageDescription, introduced: 5.6)
public enum PluginCommandIntent {
/// The plug-in generates documentation.
///
/// The command used to generate documentation, either by parsing the
/// package contents directly or by using the build system support for generating
/// symbol graphs. Invoked by a `generate-documentation` verb to `swift package`.
case documentationGeneration
/// The plug-in formats source code.
///
/// The command used to modify the source code in the package based
/// on a set of rules. Invoked by a `format-source-code` verb to `swift package`.
case sourceCodeFormatting
/// A custom command plug-in intent.
///
/// Use this case when none of the predefined cases fulfill the role of the plug-in.
/// - Parameters:
/// - verb: The invocation verb of the plug-in.
/// - description: A human readable description of the plug-in's role.
case custom(verb: String, description: String)
}
@available(_PackageDescription, introduced: 5.6)
public extension PluginCommandIntent {
/// The plugin generates documentation.
///
/// The intent of the command is to generate documentation, either by parsing the
/// package contents directly or by using the build system support for generating
/// symbol graphs. Invoked by a `generate-documentation` verb to `swift package`.
///
/// - Returns: A `PluginCommandIntent` instance.
static func documentationGeneration() -> PluginCommandIntent {
return documentationGeneration
}
/// The plug-in formats source code.
///
/// The intent of the command is to modify the source code in the package based
/// on a set of rules. Invoked by a `format-source-code` verb to `swift package`.
///
/// - Returns: A `PluginCommandIntent` instance.
static func sourceCodeFormatting() -> PluginCommandIntent {
return sourceCodeFormatting
}
}
/// The type of permission a plug-in requires.
///
/// Supported types are ``allowNetworkConnections(scope:reason:)`` and ``writeToPackageDirectory(reason:)``.
@available(_PackageDescription, introduced: 5.6)
public enum PluginPermission {
/// Create a permission to make network connections.
///
/// The command plug-in requires permission to make network connections. The `reason` string is shown
/// to the user at the time of request for approval, explaining why the plug-in is requesting access.
/// - Parameter scope: The scope of the permission.
/// - Parameter reason: A reason why the permission is needed. This is shown to the user when permission is sought.
@available(_PackageDescription, introduced: 5.9)
case allowNetworkConnections(scope: PluginNetworkPermissionScope, reason: String)
/// Create a permission to modify files in the package's directory.
///
/// The command plug-in requires permission to modify the files under the package
/// directory. The `reason` string is shown to the user at the time of request
/// for approval, explaining why the plug-in requests access.
/// - Parameter reason: A reason why the permission is needed. This is shown to the user when permission is sought.
case writeToPackageDirectory(reason: String)
}
/// The scope of a network permission.
///
/// The scope can be none, local connections only, or all connections.
@available(_PackageDescription, introduced: 5.9)
public enum PluginNetworkPermissionScope {
/// Do not allow network access.
case none
/// Allow local network connections; can be limited to a list of allowed ports.
case local(ports: [Int] = [])
/// Allow local and outgoing network connections; can be limited to a list of allowed ports.
case all(ports: [Int] = [])
/// Allow connections to Docker through UNIX domain sockets.
case docker
/// Allow connections to any UNIX domain socket.
case unixDomainSocket
/// Allow local and outgoing network connections, limited to a range of allowed ports.
public static func all(ports: Range<Int>) -> PluginNetworkPermissionScope {
return .all(ports: Array(ports))
}
/// Allow local network connections, limited to a range of allowed ports.
public static func local(ports: Range<Int>) -> PluginNetworkPermissionScope {
return .local(ports: Array(ports))
}
}
extension Target.PluginUsage {
/// Specifies use of a plugin target in the same package.
///
/// - Parameter name: The name of the plugin target.
/// - Returns: A `PluginUsage` instance.
@available(_PackageDescription, introduced: 5.5)
public static func plugin(name: String) -> Target.PluginUsage {
return .plugin(name: name, package: nil)
}
}
// MARK: ExpressibleByStringLiteral
/// `ExpressibleByStringLiteral` conformance.
///
extension Target.Dependency: ExpressibleByStringLiteral {
/// Creates a target dependency instance with the given value.
///
/// - Parameter value: A string literal.
public init(stringLiteral value: String) {
self = .byNameItem(name: value, condition: nil)
}
}
/// `ExpressibleByStringLiteral` conformance.
///
extension Target.PluginUsage: ExpressibleByStringLiteral {
/// Specifies use of a plugin target in the same package.
///
/// - Parameter value: A string literal.
public init(stringLiteral value: String) {
self = .plugin(name: value, package: nil)
}
}
|