Release 2.0

.github/workflows/tuist.yml

@@ -114,7 +114,6 @@ jobs:
             'run',
             'scaffold',
             'test',
-            'up',
             'graph',
             'tasks',
           ]

CHANGELOG.md

@@ -4,6 +4,114 @@ Please, check out guidelines: https://keepachangelog.com/en/1.0.0/
 
 ## Next
 
+## 2.0 - Ikigai
+
+### Changed
+
+- **Breaking** made constructors from scheme action models internal and exposed static methods for initializing them instead. For example, `TestAction.init(..)` becomes `TestAction.testAction(...)`. [#3400](https://github.com/tuist/tuist/pull/3400) by [@pepibumur](https://github.com/pepibumur):
+  - **Motivation:**: Using static initializers gives us the flexibility to introduce improvements without breaking the API.
+  - **Migration:** Update all the action initializers to use the static methods instead. The name of the static method matches the name of the class but starting with a lowercase.
+- **Breaking** `tuist focus` no longer includes automatically related tests and bundle targets as sources. [#3501](https://github.com/tuist/tuist/pull/3501) by [@danyf90](https://github.com/danyf90).
+  - **Motivation:** the behavior might cause to include unwanted targets in some scenario
+  - **Migration:** if you need to include tests and bundle targets as sources, specify them as arguments of the `tuist focus` command
+
+### Removed
+
+- **Breaking** `.cocoapods` target dependency
+  - **Motivation:** `.cocoapods`'s API led users to believe their integration issues were Tuist's fault. Therefore we decided to remove it and make it an explicit action developers need to run after the generation of Xcode projects through Tuist.
+  - **Migration:** we recommend wrapping the the generation of projects in a script that runs `pod install` right after generating the project: `tuist generate && pod install`. Alternatively, you might consider adopting Swift Package Manager and using our built-in support for package dependencies through the `Dependencies.swift` manifes tfile.
+- **Breaking** Support for deprecated `TuistConfig.swift` has been ended. Define your configuration using `Config.swift`. Check [documentation](https://docs.tuist.io/manifests/config) for details. [#3373](https://github.com/tuist/tuist/pull/3373) by [@laxmorek](https://github.com/laxmorek)
+- **Breaking** Support for deprecated `Template.swift` has been ended. Define your templates using any name that describes them (`name_of_template.swift`). Check [documentation](https://docs.tuist.io/commands/scaffold) for details. [#3373](https://github.com/tuist/tuist/pull/3373) by [@laxmorek](https://github.com/laxmorek)
+  - **Migration:** we recommend wrapping the generation of projects in a script that runs `pod install` right after generating the project: `tuist generate && pod install`. Alternatively, you might consider adopting Swift Package Manager and using our built-in support for package dependencies through the `Dependencies.swift` manifest file.
+- **Breaking** simplified `TestAction`'s methods for creating an instance. [#3375](https://github.com/tuist/tuist/pull/3375) by [@pepibumur](https://github.com/pepibumur):
+  - **Motivation:** there was some redundancy across all the methods to initialize a `TestAction`. To ease its usage, we've simplified all of them into a single method. It takes the test plans as an array of `Path`s and the configuration as an instance of `PresetBuildConfiguration`. We've also made the `init` constructor internal to have the flexibility to change the signature without introducing breaking changes.
+  - **Migration:** In those places where you are initializing a `TestAction`, update the code to use either the `.testActions` or the `.targets` methods.
+- **Breaking** removed the `tuist doc` command. [#3401](https://github.com/tuist/tuist/pull/3401) by [@pepibumur](https://github.com/pepibumur)
+  - **Motivation:** the command was barely used so we are removing it to reduce the maintenance burden and reduce the binary size.
+  - **Migration:** you can use Tuist tasks or [Fastlane](https://github.com/fastlane/fastlane) to run [swift-doc](https://github.com/SwiftDocOrg/swift-doc) and generate documentation from your generated projects.
+- **Breaking** removed `PresetBuildConfiguration` in favour of `ConfigurationName`. [#3400](https://github.com/tuist/tuist/pull/3400) by [@pepibumur](https://github.com/pepibumur):
+  - **Motivation:** Making the configuration a type gives the developers the flexibility to provide their list of configurations through extensions. For example, `ConfigurationName.beta`.
+  - **Migration:** Scheme actions are now initialized passing a `configuration` argument of type `ConfigurationName`. Note that it conforms `ExpressibleByStringLiteral` so you can initialize it with a string literal.
+- **Breaking** removed the `tuist up` command in favour of a sidecar CLI tool, [`tuist-up`](https://github.com/tuist/tuist-up) that can be installed independently.
+  - **Motivation:** provisioning environments for working with Xcode projects was outside of the scope of the project. Moreover, it added up to our triaging and maintenace work because errors that bubbled up from underlying commands made people think that they were Tuist bugs.
+  - **Migration:** as suggested [here](https://github.com/tuist/tuist-up), turn your `Setup.swift` into a `up.toml` and use `tuist-up` instead.
+- **Breaking** Scheme `TestAction` options have been consolidated together under a new type `TestActionOptions`.
+  - **Motivation:** This makes the API consistent with some of the other Scheme actions as well as how it appears in the Scheme editor.
+  - **Migration:** Use `TestAction.targets(options: .options(language:region:codeCoverage:codeCoverageTargets))`
+    - `TestAction.language` > `TestActionOptions.language`
+    - `TestAction.region` > `TestActionOptions.region`
+    - `TestAction.codeCoverage` > `TestActionOptions.codeCoverage`
+    - `TestAction.codeCoverageTargets` > `TestActionOptions.codeCoverageTargets`
+- **Breaking** removed deprecated `TUIST_*` configuration variables. [#3493](https://github.com/tuist/tuist/pull/3493) by [@danyf90](https://github.com/danyf90).
+  - **Motivation:**: They have been replaced by the corresponding `TUIST_CONFIG_*` variables instead.
+  - **Migration:** Use the corresponding `TUIST_CONFIG_*` variables instead.
+
+- **Breaking** `Settings` is now publicly initialized via a new static method `.settings()`.
+  - **Motivation:** Using static initializers gives us the flexibility to introduce improvements without breaking the API.
+  - **Migration:** Replace `settings: Settings(base: ["setting": "value"])` with `settings: .settings(base: ["setting": "value"])`
+
+- **Breaking** `CustomConfiguration` has been merged with `Configuration`.
+  - **Motivation:** Simplify the API and reduce confusion between `Configuration` and `CustomConfiguration`.
+  - **Migration:** Replace `let configurations: [CustomConfiguration] = [ ... ]` with `let configurations: [Configuration] = [ ... ]`.
+
+- **Breaking** Specifying custom build settings files for default configurations via `Settings(base:debug:release:)` has changed.
+  - **Motivation:** To support the `CustomConfiguration` API simplification.
+  - **Migration:** 
+    Replace 
+
+    ```swift
+    let settings = Settings(
+        debug: Configuration(settings: ["setting": "debug"]), 
+        release: Configuration(settings: ["setting": "release"])
+    )
+    ```
+
+    with:
+
+    ```swift
+    let settings: Settings = .settings(
+        debug: ["setting": "debug"], 
+        release: ["setting": "release"]
+    )
+    ```
+
+- **Breaking** Specifying xcconfig files for default configurations via `Settings(base:debug:release:)` has changed.
+  - **Motivation:** To support the `CustomConfiguration` API simplification.
+  - **Migration:** 
+    Replace 
+
+    ```swift
+    let settings = Settings(
+        debug: Configuration(xcconfig: "configs/debug.xcconfig"), 
+        release: Configuration(xcconfig: "configs/release.xcconfig")
+    )
+    ```
+
+    with:
+
+    ```swift
+    let settings: Settings = .settings(
+        configurations: [
+          .debug(name: .debug, xcconfig: "configs/debug.xcconfig"),
+          .release(name: .release, xcconfig: "configs/release.xcconfig"),
+        ]
+    )
+    ```
+- **Breaking** Rename target `actions` to `scripts` to align with Xcode's terminology [#3374](https://github.com/tuist/tuist/pull/3374) by [@pepibumur](https://github.com/pepibumur)
+  - **Motivation** To align with Xcode's terminology used for the build phase counterpart, `scripts`.
+  - **Migration**
+    Replace
+
+    ```swift
+    let target = Target(actions: [.post(tool: "/bin/echo", arguments: ["rocks"], name: "tuist")])
+    ```
+
+    with
+
+    ```swift
+    let target = Target(scripts: [.post(tool: "/bin/echo", arguments: ["rocks"], name: "tuist")])
+    ```
+
 ## 1.52.0 - Pelae
 
 ### Changed

Package.swift

@@ -110,40 +110,6 @@ let package = Package(
             name: "TuistCoreIntegrationTests",
             dependencies: ["TuistCore", "TuistSupportTesting"]
         ),
-        .target(
-            name: "TuistDoc",
-            dependencies: [
-                swiftToolsSupportDependency,
-                "TuistCore",
-                "TuistGraph",
-                "TuistSupport",
-                signalsDependency,
-                rxBlockingDependency,
-            ]
-        ),
-        .target(
-            name: "TuistDocTesting",
-            dependencies: [
-                "TuistDoc",
-                swiftToolsSupportDependency,
-                "TuistCore",
-                "TuistCoreTesting",
-                "TuistSupportTesting",
-            ]
-        ),
-        .testTarget(
-            name: "TuistDocTests",
-            dependencies: [
-                "TuistDoc",
-                "TuistDocTesting",
-                swiftToolsSupportDependency,
-                "TuistSupportTesting",
-                "TuistCore",
-                "TuistCoreTesting",
-                "TuistGraphTesting",
-                "TuistSupport",
-            ]
-        ),
         .target(
             name: "TuistKit",
             dependencies: [
@@ -166,7 +132,6 @@ let package = Package(
                 "TuistDependencies",
                 "TuistLinting",
                 "TuistCloud",
-                "TuistDoc",
                 "GraphViz",
                 "TuistMigration",
                 "TuistAsyncQueue",
@@ -196,7 +161,6 @@ let package = Package(
                 "TuistDependenciesTesting",
                 "TuistLintingTesting",
                 "TuistMigrationTesting",
-                "TuistDocTesting",
                 "TuistAsyncQueueTesting",
                 "TuistGraphTesting",
                 "TuistPlugin",

Project.swift

@@ -111,7 +111,6 @@ func targets() -> [Target] {
                 .target(name: "TuistDependencies"),
                 .target(name: "TuistLinting"),
                 .target(name: "TuistCloud"),
-                .target(name: "TuistDoc"),
                 .target(name: "TuistMigration"),
                 .target(name: "TuistAsyncQueue"),
                 .target(name: "TuistAnalytics"),
@@ -135,7 +134,6 @@ func targets() -> [Target] {
                 .target(name: "TuistDependenciesTesting"),
                 .target(name: "TuistLintingTesting"),
                 .target(name: "TuistMigrationTesting"),
-                .target(name: "TuistDocTesting"),
                 .target(name: "TuistAsyncQueueTesting"),
                 .target(name: "TuistGraphTesting"),
                 .target(name: "TuistPlugin"),
@@ -152,26 +150,6 @@ func targets() -> [Target] {
                 .target(name: "TuistGraphTesting"),
             ]
         ),
-        Target.module(
-            name: "TuistDoc",
-            dependencies: [
-                .target(name: "TuistCore"),
-                .target(name: "TuistGraph"),
-                .target(name: "TuistSupport"),
-            ],
-            testDependencies: [
-                .target(name: "TuistSupportTesting"),
-                .target(name: "TuistCore"),
-                .target(name: "TuistCoreTesting"),
-                .target(name: "TuistGraphTesting"),
-                .target(name: "TuistSupport"),
-            ],
-            testingDependencies: [
-                .target(name: "TuistCore"),
-                .target(name: "TuistCoreTesting"),
-                .target(name: "TuistSupportTesting"),
-            ]
-        ),
         Target.module(
             name: "TuistEnvKit",
             hasTesting: false,

Sources/ProjectDescription/AnalyzeAction.swift

@@ -1,13 +1,16 @@
 import Foundation
 
 public struct AnalyzeAction: Equatable, Codable {
-    public let configurationName: String
+    public let configuration: ConfigurationName
 
-    public init(configurationName: String) {
-        self.configurationName = configurationName
+    init(configuration: ConfigurationName) {
+        self.configuration = configuration
     }
 
-    public init(config: PresetBuildConfiguration = .release) {
-        self.init(configurationName: config.name)
+    /// Returns an analyze action.
+    /// - Parameter configuration: Configuration used for analyzing.
+    /// - Returns: Analyze action.
+    public static func analyzeAction(configuration: ConfigurationName) -> AnalyzeAction {
+        return AnalyzeAction(configuration: configuration)
     }
 }

Sources/ProjectDescription/ArchiveAction.swift

@@ -1,23 +1,39 @@
 import Foundation
 
 public struct ArchiveAction: Equatable, Codable {
-    public let configurationName: String
+    public let configuration: ConfigurationName
     public let revealArchiveInOrganizer: Bool
     public let customArchiveName: String?
     public let preActions: [ExecutionAction]
     public let postActions: [ExecutionAction]
 
-    public init(
-        configurationName: String,
+    init(
+        configuration: ConfigurationName,
         revealArchiveInOrganizer: Bool = true,
         customArchiveName: String? = nil,
         preActions: [ExecutionAction] = [],
         postActions: [ExecutionAction] = []
     ) {
-        self.configurationName = configurationName
+        self.configuration = configuration
         self.revealArchiveInOrganizer = revealArchiveInOrganizer
         self.customArchiveName = customArchiveName
         self.preActions = preActions
         self.postActions = postActions
     }
+
+    public static func archiveAction(
+        configuration: ConfigurationName,
+        revealArchiveInOrganizer: Bool = true,
+        customArchiveName: String? = nil,
+        preActions: [ExecutionAction] = [],
+        postActions: [ExecutionAction] = []
+    ) -> ArchiveAction {
+        return ArchiveAction(
+            configuration: configuration,
+            revealArchiveInOrganizer: revealArchiveInOrganizer,
+            customArchiveName: customArchiveName,
+            preActions: preActions,
+            postActions: postActions
+        )
+    }
 }

Sources/ProjectDescription/Arguments.swift

@@ -4,15 +4,6 @@ public struct Arguments: Equatable, Codable {
     public let environment: [String: String]
     public let launchArguments: [LaunchArgument]
 
-    @available(*, deprecated, message: "Use init with `launchArguments: [LaunchArgument]` instead")
-    public init(environment: [String: String] = [:],
-                launchArguments: [String: Bool])
-    {
-        self.environment = environment
-        self.launchArguments = launchArguments.map(LaunchArgument.init)
-            .sorted { $0.name < $1.name }
-    }
-
     public init(environment: [String: String] = [:],
                 launchArguments: [LaunchArgument] = [])
     {

Sources/ProjectDescription/BuildAction.swift

@@ -16,4 +16,24 @@ public struct BuildAction: Equatable, Codable {
         self.postActions = postActions
         self.runPostActionsOnFailure = runPostActionsOnFailure
     }
+
+    /// Returns a build action.
+    /// - Parameters:
+    ///   - targets: Targets to be built.
+    ///   - preActions: Actions to run before building.
+    ///   - postActions: Actions to run after building.
+    ///   - runPostActionsOnFailure: Whether pre and post actions should run on failure.
+    /// - Returns: Initialized build action.
+    public static func buildAction(targets: [TargetReference],
+                                   preActions: [ExecutionAction] = [],
+                                   postActions: [ExecutionAction] = [],
+                                   runPostActionsOnFailure: Bool = false) -> BuildAction
+    {
+        return BuildAction(
+            targets: targets,
+            preActions: preActions,
+            postActions: postActions,
+            runPostActionsOnFailure: runPostActionsOnFailure
+        )
+    }
 }

Sources/ProjectDescription/Config.swift

@@ -1,7 +1,5 @@
 import Foundation
 
-public typealias TuistConfig = Config
-
 /// This model allows to configure Tuist.
 public struct Config: Codable, Equatable {
     /// Contains options related to the project generation.

Sources/ProjectDescription/ConfigurationName.swift

@@ -0,0 +1,38 @@
+import Foundation
+
+/// It represent's a project configuration.
+public struct ConfigurationName: ExpressibleByStringLiteral, Codable, Equatable {
+    /// Configuration name.
+    public let rawValue: String
+
+    internal init(_ rawValue: String) {
+        self.rawValue = rawValue
+    }
+
+    /// Initializes a configuration name with its name.
+    /// - Parameter value: Configuration name.
+    public init(stringLiteral value: StringLiteralType) {
+        self.init(value)
+    }
+
+    /// Initializes a configuration name with its name.
+    /// - Parameter name: Configuration name.
+    /// - Returns: Initialized configuration name.
+    public static func configuration(_ name: String) -> ConfigurationName {
+        self.init(name)
+    }
+}
+
+// Defaults provided by Tuist
+
+public extension ConfigurationName {
+    /// Returns a configuration named "Debug"
+    static var debug: ConfigurationName {
+        ConfigurationName("Debug")
+    }
+
+    // Returns a configuration named "Release"
+    static var release: ConfigurationName {
+        ConfigurationName("Release")
+    }
+}