Vitaliy asked about how to do something with the tuist scaffold command, and I decided to document the answer because it applies to any request for flexibility in that command.
In total transparency, the future plans for tuist scaffold are uncertain. There’s a possibility that we don’t invet more in it. Why? You might guess… we are thinking about providing an automation layer (which you’ll see us referring to as workflows), which can be a foundation for you to build not only your own scaffolding scripts, but really anything.
But until that happens. I’d like to provide you with a way forward.
So if you come across needing more from tuist scaffold I’d recommend the following:
1 - Create a Mise task
Create a file at mise/tasks/scaffold. You can choose the programming language you want to write your script in: Ruby, JavaScript (e.g. NodeJS), Bash…
If you want to go with Swift, I recommend using swift-sh by adding the project as a dependency of yours in your project’s mise.toml:
[tools]
"spm:mxcl/swift-sh" = "2.5.0"
It’d be great if mxcl/swift-sh provided binaries so that you didn’t have to compile the binary, so I’d recommend opening a PR/issue there proposing the improvement.
Don’t forget to give the task executing permissions chmod +x mise/tasks/scaffold
2 - Implement the task
Add some content to your task:
#!/usr/bin/swift sh
print("Hello world")
And then run it with mise run scaffold. Cool, isn’t it?
3 - Define the interface using usage
Mise uses usage internally to allow declaring the interface of your script using comments. Change your script to:
#!/usr/bin/env swift sh
//MISE description="Scaffold new features"
//USAGE flag "-n --name <name>" help="The name of the feature"
import Foundation
let featureName = ProcessInfo.processInfo.environment["usage_user"]
if let featureName {
print("Creating feature \(featureName)")
}
Easy, isn’t it? You can now do mise run scaffold --name Feature
4 - Add dependencies
You’ll most likely want to depend on some packages because Foundation is limited for scripting. You can easily so by adding the imports and a comment with the dependency:
#!/usr/bin/env swift sh
//MISE description="Scaffold new features"
//USAGE flag "-n --name <name>" help="The name of the feature"
import Foundation
import SwiftGenKit // [email protected]:SwiftGen/SwiftGen.git ~> 6.6.3
let featureName = ProcessInfo.processInfo.environment["usage_user"]
if let featureName {
print("Creating feature \(featureName)")
}
Note how we are adding SwiftGenKit as a dependency so the possibilities are endless. I’d recommend checking out Command, FileSystem, and Path, which Tuist uses internally and are handy for scripting.
Bonus
You’ll most likely want to edit those scripts in the same way you do with Tuist. swift-sh got you covered too. Add the following tasks to mise/tasks/edit/scaffold:
#!/usr/bin/env bash
#MISE description="Edit the scaffold script"
/usr/bin/env swift sh edit mise/tasks/scaffold
And then run mise run edit:scaffold. You’ll notice Xcode is unhappy with the shebang line (i.e., #!/usr/bin/env bash) but you can comment that one out while editing.
Note
As you noted, we are not really that far from enabling a Fastlane-like experience using Swift. So I recommend using this over our tuist scaffold. If you build a cool Swift Package, don’t forget to share it here for other people following a similar path.
Alternative approach: Using a Swift Package
Example executable task (in mise/tasks/scaffold):