Add Support for Custom Build Rules #197
Conversation
briantkelley
force-pushed
the
pbxbuildrule
branch
from
dc33c09
to
b564743
Compare
Generated by 🚫 Danger |
briantkelley
force-pushed
the
pbxrezbuildphase
branch
from
fb7c56b
to
6167d59
Compare
briantkelley
force-pushed
the
pbxbuildrule
branch
from
b564743
to
bb1e2ed
Compare
Sources/xcproj/PBXBuildRule.swift
Outdated
| public var fileType: String | ||
|
|
||
| /// Element is editable. | ||
| public var isEditable: UInt |
There was a problem hiding this comment.
Can this take any other values than 1 or 0? Otherwise we can make it a Bool
There was a problem hiding this comment.
I believe it's only ever a 1 or 0. There were some existing seemingly Bool properties were using (U)Int but definitely happy to change it.
There was a problem hiding this comment.
Yeah, those other ones could be changed in 2.0 as it's a breaking change
Sources/xcproj/PBXBuildRule.swift
Outdated
| public var outputFilesCompilerFlags: [String]? | ||
|
|
||
| /// Element script. | ||
| public var script: String |
There was a problem hiding this comment.
Script is also optional right? Is there an advantage to making it non optional?
There was a problem hiding this comment.
Nice catch. This should definitely be optional.
briantkelley
force-pushed
the
pbxbuildrule
branch
from
bb1e2ed
to
fd9c669
Compare
|
Thanks for the feedback @yonaskolb. Updated the PR. |
Some Xcode projects have custom build rules to automatically invoke a tool when an input file changes. Add a PBXObject subclass, PBXBuildRule, which describes when and how a custom build tool should be invoked. Update PBXProj to store custom build rules and add decoding/encoding support. In addition to updating the tests, verified xcproj correctly round trips a project with custom build rules (custom pattern/custom tool, custom pattern/built-in tool, built-in pattern/custom tool, built-in pattern/built-in tool).
briantkelley
force-pushed
the
pbxbuildrule
branch
from
fd9c669
to
faf90a0
Compare
| public init(reference: String, | ||
| compilerSpec: String, | ||
| filePatterns: String? = nil, | ||
| fileType: String, |
There was a problem hiding this comment.
One more very minor thing. As fileType is non optional (I don't know if it should be or not), can we move it before optional filePatterns?
| public var compilerSpec: String | ||
|
|
||
| /// Element file patterns. | ||
| public var filePatterns: String? |
There was a problem hiding this comment.
Out of curiosity. Did you check the optionality of the attributes with Xcode?
There was a problem hiding this comment.
Thanks for fixing this up and merging. @pepibumur, yes, I tried examining the encoded form of of a number of different permutations. compilerSpec is required so specify how the file should be processed, but filePatterns is optional since it's a filter on fileType.
There was a problem hiding this comment.
No problem @briantkelley 😛 it was just curiosity. The changes should be in xcproj 1.8.0 ready to be used :)
Short description 📝
Add support for custom build rules, which Xcode uses to automatically invoke a tool when a matching input file changes.
Solution 📦
Add a PBXObject subclass, PBXBuildRule, which can load and store the custom build rule configuration.
Implementation 👩💻👨💻
PBXBuildRule, which is a subclass ofPBXObjectand add properties for all possible fields in the Xcode project file. Implement Equatable, Decodable, and encoding support.PBXObjectandPBXProjto support decodingPBXProjandPBXProjEncoderto support encodingThis change is