Add support for adding build tool plugins to targets (#1374)

* Add support for adding build tool plugins to targets

* Added Plugin validation

* Added some tests

* Limited the minimum version to 5.7 Swift

* Update .gitignore

Co-authored-by: freddi(Yuki Aki) <freddi-kit@users.noreply.github.com>

* Update CHANGELOG.md

Co-authored-by: freddi(Yuki Aki) <freddi-kit@users.noreply.github.com>

* Update CHANGELOG.md

Co-authored-by: freddi(Yuki Aki) <freddi-kit@users.noreply.github.com>

* Update Docs/ProjectSpec.md

Co-authored-by: freddi(Yuki Aki) <freddi-kit@users.noreply.github.com>

* Added a fixture for testing plugins

* Update CHANGELOG.md

* Installed the release version of XcodeProj

---------

Co-authored-by: freddi(Yuki Aki) <freddi-kit@users.noreply.github.com>

Author: BarredEwe

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - Fixed source file `includes` not working when no paths were found #1337 @shnhrrsn
 
+### Added
+
+- Added support for adding `Build Tool Plug-ins` to targets #1374 @BarredEwe
+
 ## 2.36.1
 
 ### Fixed

Docs/ProjectSpec.md

@@ -27,6 +27,7 @@ You can also use environment variables in your configuration file, by using `${S
   - [Dependency](#dependency)
   - [Config Files](#config-files)
   - [Plist](#plist)
+  - [Build Tool Plug-ins](#build-tool-plug-ins)
   - [Build Script](#build-script)
   - [Build Rule](#build-rule)
   - [Target Scheme](#target-scheme)
@@ -381,6 +382,7 @@ Settings are merged in the following order: `groups`, `base`, `configs` (simple
 - [ ] **directlyEmbedCarthageDependencies**: **Bool** - If this is `true` Carthage framework dependencies will be embedded using an `Embed Frameworks` build phase instead of the `copy-frameworks` script. Defaults to `true` for all targets except iOS/tvOS/watchOS Applications.
 - [ ] **requiresObjCLinking**: **Bool** - If this is `true` any targets that link to this target will have `-ObjC` added to their `OTHER_LDFLAGS`. This is required if a static library has any categories or extensions on Objective-C code. See [this guide](https://pewpewthespells.com/blog/objc_linker_flags.html#objc) for more details. Defaults to `true` if `type` is `library.static`. If you are 100% sure you don't have categories or extensions on Objective-C code (pure Swift with no use of Foundation/UIKit) you can set this to `false`, otherwise it's best to leave it alone.
 - [ ] **onlyCopyFilesOnInstall**: **Bool** – If this is `true`, the `Embed Frameworks` and `Embed App Extensions` (if available) build phases will have the "Copy only when installing" chekbox checked. Defaults to `false`.
+- [ ] **buildToolPlugins**: **[[Build Tool Plug-ins](#build-tool-plug-ins)]** - Commands for the build system that run automatically *during* the build.
 - [ ] **preBuildScripts**: **[[Build Script](#build-script)]** - Build scripts that run *before* any other build phases
 - [ ] **postCompileScripts**: **[[Build Script](#build-script)]** - Build scripts that run after the Compile Sources phase
 - [ ] **postBuildScripts**: **[[Build Script](#build-script)]** - Build scripts that run *after* any other build phases
@@ -695,6 +697,36 @@ targets:
         com.apple.security.application-groups: group.com.app
 ```
 
+### Build Tool Plug-ins
+
+To add `Build Tool Plug-ins`, you need to add information about plugins to [Target](#target):
+
+- **buildToolPlugins**: List of plugins to connect to the target
+
+Each plugin includes information:
+
+- [x] **plugin**: **String** - plugin name 
+- [x] **package**: **String** - the name of the package that contains the plugin
+
+Сonnect the plugin to the desired target:
+
+```yaml
+targets:
+  App:
+    buildToolPlugins:
+      - plugin: MyPlugin
+        package: MyPackage
+```
+
+Don't forget to add a package containing the plugin we need:
+
+```yaml
+packages:
+  MyPackage:
+    url: https://github.com/MyPackage
+    from: 1.3.0
+```
+
 ### Build Script
 
 Run script build phases can be added at 3 different points in the build:
@@ -854,6 +886,7 @@ This is used to override settings or run build scripts in specific targets
 - [x] **targets**: **[String]** - The list of target names to include as target dependencies
 - [ ] **configFiles**: **[Config Files](#config-files)** - `.xcconfig` files per config
 - [ ] **settings**: **[Settings](#settings)** - Target specific build settings.
+- [ ] **buildToolPlugins**: **[[Build Tool Plug-ins](#build-tool-plug-ins)]** - Commands for the build system that run automatically *during* the build
 - [ ] **buildScripts**: **[[Build Script](#build-script)]** - Build scripts to run
 - [ ] **scheme**: **[Target Scheme](#target-scheme)** - Generated scheme
 - [ ] **attributes**: **[String: Any]** - This sets values in the project `TargetAttributes`. It is merged with `attributes` from the project and anything automatically added by XcodeGen, with any duplicate values being override by values specified here

Docs/Usage.md

@@ -204,3 +204,20 @@ targets:
     dependencies:
       - framework: Vendor/MyFramework.framework
 ```
+
+# Build Tool Plug-ins
+XCodeGen supports working with [Swift Package Plug-ins](https://github.com/apple/swift-package-manager/blob/main/Documentation/Plugins.md#using-a-package-plugin).
+
+To use plugins, you need to specify in your target which plugin you want to connect, and don't forget to connect the package to target.
+
+```yaml
+packages:
+  Prefire:
+    url: https://github.com/BarredEwe/Prefire
+    from: 1.3.0
+targets:
+  App:
+    buildToolPlugins:
+      - plugin: PrefirePlaybookPlugin
+        package: Prefire
+```

Package.resolved

@@ -16,7 +16,7 @@ let package = Package(
         .package(url: "https://github.com/yonaskolb/JSONUtilities.git", from: "4.2.0"),
         .package(url: "https://github.com/kylef/Spectre.git", from: "0.9.2"),
         .package(url: "https://github.com/onevcat/Rainbow.git", from: "3.0.0"),
-        .package(url: "https://github.com/tuist/XcodeProj.git", from: "8.12.0"),
+        .package(url: "https://github.com/tuist/XcodeProj.git", from: "8.13.0"),
         .package(url: "https://github.com/jakeheis/SwiftCLI.git", from: "6.0.3"),
         .package(url: "https://github.com/mxcl/Version", from: "2.0.0"),
         .package(url: "https://github.com/SwiftDocOrg/GraphViz.git", exact: "0.2.0"),

Package.swift

@@ -0,0 +1,58 @@
+import Foundation
+import JSONUtilities
+
+/// Specifies the use of a plug-in product in a target.
+public struct BuildToolPlugin: Equatable {
+
+    /// The name of the plug-in target.
+    public var plugin: String
+    /// The name of the package that defines the plug-in target.
+    public var package: String
+    
+    public init(
+        plugin: String,
+        package: String
+    ) {
+        self.plugin = plugin
+        self.package = package
+    }
+}
+
+extension BuildToolPlugin: JSONObjectConvertible {
+
+    public init(jsonDictionary: JSONDictionary) throws {
+        if let plugin: String = jsonDictionary.json(atKeyPath: "plugin") {
+            self.plugin = plugin
+        } else {
+            throw SpecParsingError.invalidDependency(jsonDictionary)
+        }
+        
+        if let package: String = jsonDictionary.json(atKeyPath: "package") {
+            self.package = package
+        } else {
+            throw SpecParsingError.invalidDependency(jsonDictionary)
+        }
+    }
+}
+
+extension BuildToolPlugin {
+    public var uniqueID: String {
+        return "\(plugin)/\(package)"
+    }
+}
+
+extension BuildToolPlugin: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(plugin)
+        hasher.combine(package)
+    }
+}
+
+extension BuildToolPlugin: JSONEncodable {
+    public func toJSONValue() -> Any {
+        [
+            "plugin": plugin,
+            "package": package
+        ]
+    }
+}

Sources/ProjectSpec/BuildToolPlugin.swift

@@ -174,6 +174,12 @@ extension Project {
                     errors.append(.invalidTargetSource(target: target.name, source: sourcePath.string))
                 }
             }
+
+            for buildToolPlugin in target.buildToolPlugins {
+                if packages[buildToolPlugin.package] == nil {
+                    errors.append(.invalidPluginPackageReference(plugin: buildToolPlugin.plugin, package: buildToolPlugin.package))
+                }
+            }
         }
 
         for projectReference in projectReferences {

Sources/ProjectSpec/SpecValidation.swift

@@ -36,6 +36,7 @@ public struct SpecValidationError: Error, CustomStringConvertible {
         case invalidTestPlan(TestPlan)
         case multipleDefaultTestPlans
         case duplicateDependencies(target: String, dependencyReference: String)
+        case invalidPluginPackageReference(plugin: String, package: String)
 
         public var description: String {
             switch self {
@@ -91,6 +92,8 @@ public struct SpecValidationError: Error, CustomStringConvertible {
                 return "Your test plans contain more than one default test plan"
             case let .duplicateDependencies(target, dependencyReference):
                  return "Target \(target.quoted) has the dependency \(dependencyReference.quoted) multiple times"
+            case let .invalidPluginPackageReference(plugin, package):
+                return "Plugin \(plugin) has invalide package reference \(package)"
             }
         }
     }