Exposed method to write project, workspace, schemes and breakpoints #215
Conversation
ilyapuchka
force-pushed
the
write-paths
branch
from
c052ea5 to
5e1aac5
Compare
CHANGELOG.md
Outdated
| @@ -9,6 +9,7 @@ | |||
|
|
|||
| ### Changed | |||
| - **Breaking:** `XCWorkspace.Data` renamed to `XCWorkspaceData` and removed `references`. | |||
| - Added methods to get paths to workspace, project and breakpoints and shemes files, added public methods to write them separatery. | |||
There was a problem hiding this comment.
Don't forget to add your GitHub handle at the end here @ilyapuchka 😛
Sources/xcproj/XcodeProj.swift
Outdated
| /// | ||
| /// - Parameter path: `.xcodeproj` file path | ||
| /// - Returns: worspace file path relative to the given path. | ||
| public func workspacePath(_ path: Path) -> Path { |
There was a problem hiding this comment.
I think this method can be static since it doesn't need anything from the XcodeProj instance.
There was a problem hiding this comment.
I'd add a simple unit test to make sure the path si properly generated.
Sources/xcproj/XcodeProj.swift
Outdated
| /// | ||
| /// - Parameter path: `.xcodeproj` file path | ||
| /// - Returns: project file path relative to the given path. | ||
| public func projectPath(_ path: Path) -> Path { |
There was a problem hiding this comment.
Same comment here regarding making this method static and testing it.
There was a problem hiding this comment.
What about naming it pbxprojPath to make it consistent with the write method?
Sources/xcproj/XcodeProj.swift
Outdated
| /// - Parameter path: `.xcodeproj` file path | ||
| /// - Returns: shared data path relative to the given path. | ||
| public func sharedDataPath(_ path: Path) -> Path { | ||
| return path + "xcshareddata" |
There was a problem hiding this comment.
Same comment regarding making it static and testing it
There was a problem hiding this comment.
Actually the same comment applies to all the path methods that you added 😜
There was a problem hiding this comment.
Just left some minor comments @ilyapuchka. Great job on this PR 👏 . Once addressed feel free to merge it since you got another thumb up. If I'm not wrong, you should have received an invitation to be a contributor of the organization. That gives you permissions to merge PRs.
|
By the way! A downside of keeping a |
ilyapuchka
force-pushed
the
write-paths
branch
from
0e58ab0 to
c847ab3
Compare
ilyapuchka
force-pushed
the
write-paths
branch
from
c847ab3 to
19bb5c5
Compare
|
All code review comments addressed, but I can't merge this myself yet. |
|
@ilyapuchka you have to accept invitation to @xcodeswift contributors team.
|
|
@allu22 I didn't get invitation yet =) |
|
Weird... |
|
I sent you the invitation again @ilyapuchka |
|
👍 |
Short description 📝
When writing project with
XcodeProj.writethere is no control over what parts of it will be written, so i.e. workspace and schemes are being overridden when only project changes. Together with #214 it leads to unneeded changes.Solution 📦
There are public methods to write scheme, workspace, project etc. but methods used by
XcodeProj.writeprovide more functionality and automatically write data in correct paths, when writing project throughpbxproj.writerequires to construct correct path to project file manually. Also added public methods to get those paths to give users more flexibility, i.e. to write individual scheme file instead of overriding all schemes folder.This change is