Questions about implementing componentization via Tuist

[rakuyoMo]

What problem or need do you have?

Hello!

I would like to ask some questions about using Tuist to implement componentization of iOS projects.

Component directory structure

Tuist is very flexible, so what is the officially recommended componentized directory structure? So far I have found the following situations:

• There are two types of fixtures:
  • For example, ios_app_with_static_frameworks: In the root directory of the Project.swift file of the main project, each component has a separate folder.
  • For example, ios_app_with_framework_and_resources: The Project.swift file of the main project is not in the root directory. It is in its own App folder, and each component has a separate folder.
• In the documentation, it is mentioned that multiple projects should be placed in the Projects folder.

These solutions confused me as a first-time user of Tuist, and I didn’t know which one was the most correct and best. I hope to follow the official best practices, but I'm not sure if this exists.

Workspace‘s projects

In the "Workspace.swift" file, do I need to pass all projects (those with implicit dependencies, like in the example mentioned below) to "projects"?

In the example of ios_workspace_with_dependency_cycle, projects contains all projects. But not all are referenced in ios_app_with_transitive_project.

After my practice, I found that even if all projects are not included, .xcworkspace can still be generated and compiled. So if all items don't need to be included, are there any hidden risks to be aware of with this approach?

macOS version

14.4.1 (23E224)

Tuist version

4.9.0

Xcode version

15.3

[fortmarek]

There's no official approach to how you should structure your projects as it depends on your usecase and on your preferences.

Personally, I would avoid Workspace.swift and use a root Project.swift with extra Project.swift's linked from the root Project.swift (directly or transitively) just because things are simpler this way. But there are cases where Workspace.swift is useful and a root Project.swift doesn't make sense (e.g. when you have a monorepo with multiple apps).

[rakuyoMo]

So what about the first question?

[fortmarek]

Do you mean Tuist is very flexible, so what is the officially recommended componentized directory structure? As mentioned, we currently don't make an official recommendation.

[rakuyoMo]

I mean: “In the "Workspace.swift" file, do I need to pass all projects (those with implicit dependencies, like in the example mentioned below) to "projects"?”

[fortmarek]

I think you should be able to pass only your root projects (those that directly or transitively link all the other subprojects). You can also use a glob in your Workspace.swift to make linking to multiple projects easier.