Resolving relative paths with custom project destination #681
Conversation
| @@ -286,9 +288,16 @@ class SourceGenerator { | |||
| let isTopLevelGroup = (isBaseGroup && !createIntermediateGroups) || isRootPath | |||
|
|
|||
| let groupName = name ?? path.lastComponent | |||
| let groupPath = isTopLevelGroup ? | |||
| ((try? path.relativePath(from: project.basePath)) ?? path).string : | |||
There was a problem hiding this comment.
The previous implementation seems to be wrong.
According to the PBXGroup's documentation, path argument must be relative path from source root.
https://github.com/tuist/XcodeProj/blob/aefcbf59cea5b0831837ed2f385e6dfd80d82cc9/Sources/XcodeProj/Objects/Files/PBXGroup.swift#L28
However, in some situations, groupPath become path.string. It is absolute path.
| let generator = ProjectGenerator(project: project) | ||
| let generatedProject = try generator.generateXcodeProject() | ||
| let group = generatedProject.pbxproj.groups.first(where: { $0.nameOrPath == groupName }) | ||
| try expect(group?.path) == "App_iOS" |
There was a problem hiding this comment.
This value should be relative path from source root.
https://github.com/yonaskolb/XcodeGen/pull/681/files#r332485507
| let generator = ProjectGenerator(project: project) | ||
| let generatedProject = try generator.generateXcodeProject(to: destinationPath) | ||
| let group = generatedProject.pbxproj.groups.first(where: { $0.nameOrPath == groupName }) | ||
| try expect(group?.path) == "TestProject/App_iOS" |
There was a problem hiding this comment.
Test fixing this issue.
| case .some(let relativePath) where isTopLevelGroup: | ||
| groupPath = relativePath | ||
| default: | ||
| groupPath = path.lastComponent |
There was a problem hiding this comment.
Could this be simplified to use an if let
if isTopLevelGroup, let relativePath = try? path.relativePath(from: projectDirectory ?? project.basePath).string {
groupPath = relativePath
} else {
groupPath = path.lastComponent
}There was a problem hiding this comment.
There might be other places using project.basePath in the file. Perhaps we can have an instance property called projectBasePath that gets set in the initializer, which everything can read
There was a problem hiding this comment.
@yonaskolb I introduce resolveGroupPath instead. It may help us to get a good group path from projectBasePath relatively.
| @@ -13,10 +13,11 @@ public class ProjectGenerator { | |||
| self.project = project | |||
| } | |||
|
|
|||
| public func generateXcodeProject() throws -> XcodeProj { | |||
| public func generateXcodeProject(to projectDirectory: Path? = nil) throws -> XcodeProj { | |||
There was a problem hiding this comment.
minor nitpick if using naming like that:
| public func generateXcodeProject(to projectDirectory: Path? = nil) throws -> XcodeProj { | |
| public func generateXcodeProject(in projectDirectory: Path? = nil) throws -> XcodeProj { |
|
Looks good apart from a minor param name comment. Would be good to to know if this fixes this issue #260 |
|
@yonaskolb Merging is blocked because of minor changes after approval.... Could you approve this again? |
Motivation and Context
In the situation generating with
--projectoption different with spec's directory, All containing files are missing on the generated projects.$ xcodegen -p ./GeneratedProjectsThere is following directory structure.
Description
This PR solve this issue. Top Level group's location must be the relative path from the generated project.
Before :
MyFrameworkgroup's location wasMyFramework. This value comes from a relative path from the project spec. It should be a relative path fromPROJECT_ROOT.After:
MyFrameworkgroup's location chages to../MyFramework. It's a relative path fromPROJECT_ROOT.