Can Helper be used in Config.swift and Package.swift files?

[rakuyoMo]

What problem or need do you have?

I want to use ProjectDescriptionHelpers in Config.swift and Package.swift, but it seems that this is not supported at the moment?

The following operations are performed in the root directory, not in any subfolders.

When I introduce ProjectDescriptionHelpers in Config.swift and execute the mise exec -- tuist generate --verbose command, it reports an error: no such module 'ProjectDescriptionHelpers'

And the process of mise exec -- tuist install --verbose does not seem to execute the code in the #if TUIST part of the Package.swift file?

My project structure looks like this:

.
├── App
│   └── Project.swift
├── Components
│   └── InternalTools
│       ├── Project.swift
│       └── Tuist
│           ├── Config.swift
│           ├── Package.resolved
│           ├── Package.swift
│           └── ProjectDescriptionHelpers -> ../../../Tuist/ProjectDescriptionHelpers
├── Tuist
│   ├── Config.swift
│   ├── Package.resolved
│   ├── Package.swift
│   └── ProjectDescriptionHelpers
└── Workspace.swift

I want each component project in Components to compile and run independently, so I share a lot of configurations in ProjectDescriptionHelpers. Now I hope to add some SPM dependencies to ProjectDescriptionHelpers, so that the components and the main project can maintain the same dependency version.

Potential solution

No response

macOS version

14.4.1 (23E224)

Tuist version

4.9.0

Xcode version

15.3

[rakuyoMo]

When I upgraded tuist to version 4.10.1, adding import ProjectDescriptionHelpers in Config.swift would trigger a compilation error.

So I understand that Tuist does not support using ProjectDescriptionHelpers in Config.swift?

Is it possible to support using ProjectDescriptionHelpers in these two files? This is very helpful in reducing repeated definitions of configuration items.

[fortmarek]

Hey 👋

You can't use ProjectDescriptionHelpers in Config.swift. You can use ProjectDescriptionHelpers in your Package.swift in the part of the code that's run only when the compiler directive TUIST is true:

// Package.swift
// swift-tools-version:5.9

import PackageDescription
import ProjectDescriptionHelpers // This is _not_ possible

#if TUIST
    import ProjectDescription
    import ProjectDescriptionHelpers // This is possible
    ...
#endif

...

As for your project setup, I don't recommend having two Config.swift files. You should have one Config.swift for the whole repository.

[rakuyoMo]

You can use ProjectDescriptionHelpers in your Package.swift in the part of the code that's run only when the compiler directive TUIST is true:

But I cannot define dependencies in Helper, such as kingfisher. I need to fully define it in Package.swift according to SPM syntax. In this way, tuist install can download dependencies correctly.

You should have one Config.swift for the whole repository.

When I execute Tuist-related commands in the Components/InternalTools folder, can it find the Tuist/Config.swift file in the root directory?

[fortmarek]

But I cannot define dependencies in Helper, such as kingfisher. I need to fully define it in Package.swift according to SPM syntax. In this way, tuist install can download dependencies correctly.

Yes, you can't share the list of your dependencies. That's a limitation on the SPM side, though.

When I execute Tuist-related commands in the Components/InternalTools folder, can it find the Tuist/Config.swift file in the root directory?

It should, but I would also remove the duplicate Tuist directory. You shouldn't have two Tuist directories with their own Package.swift and ProjectDescriptionHelpers in one repository.

[rakuyoMo]

Currently, the files in the Components folder are integrated into the main project in the form of staticFramework. I sometimes manually change a component to an app, and then execute tuist generate to run the component separately. At this time, it would be very convenient if dependencies can be shared.

[rakuyoMo]

Yes, you can't share the list of your dependencies. That's a limitation on the SPM side, though.

Or conversely, is there a way for Tuist to read the contents of Package.swift? All in all I would like to have dependencies defined only once.

[fortmarek]

Or conversely, is there a way for Tuist to read the contents of Package.swift? All in all I would like to have dependencies defined only once.

You can create a Package.swift that has all shared dependencies and then link to it from your Tuist/Package.swift files as a local package. This will techincally pull in the transitive dependencies and they will be able for you to use.