Update tuist, refactor and finalize tuist code

Author: ImaginativeShohag

.mise.toml

@@ -1,2 +1,2 @@
 [tools]
-tuist = "latest"
+tuist = "3.42.0"

Project.swift

@@ -5,66 +5,44 @@
 import ProjectDescription
 import ProjectDescriptionHelpers
 
-private let deploymentTarget = "17.0"
+private let deploymentTargetVersion = "17.0"
 
 let project = Project.app(
     name: "Why-Not-SwiftUI",
-    platform: .iOS,
-    deploymentTarget: .iOS(
-        targetVersion: deploymentTarget,
-        devices: [.iphone, .ipad]
-    ),
+    deploymentTargets: .iOS(deploymentTargetVersion),
+    destinations: [.iPhone, .iPad, .macWithiPadDesign, .appleVisionWithiPadDesign],
     baseSettings: [
         // Signing
         "CODE_SIGN_STYLE": "Automatic",
         "DEVELOPMENT_TEAM": "UT4XSTUQLU",
 
         // Version
-        "MARKETING_VERSION": "1.0",
-        "CURRENT_PROJECT_VERSION": "1",
+        "MARKETING_VERSION": appVersion,
+        "CURRENT_PROJECT_VERSION": appBuild,
+
+        "IPHONEOS_DEPLOYMENT_TARGET": "\(deploymentTargetVersion)",
+
+        // Recommended by Xcode
+        "ENABLE_USER_SCRIPT_SANDBOXING": true
 
         // Strict concurrency checking
         // NOTE: Will try later to make app read for Swift 6.
         // "SWIFT_STRICT_CONCURRENCY": "complete"
-
-        "IPHONEOS_DEPLOYMENT_TARGET": "\(deploymentTarget)"
-    ],
-    additionalTargets: [
-        Module(
-            name: "Core",
-            hasResources: true
-        ),
-        Module(
-            name: "CommonUI",
-            hasResources: true,
-            dependencies: ["Core"]
-        ),
-        Module(
-            name: "Home",
-            dependencies: ["Core", "CommonUI"]
-        )
-    ],
-    externalDependencies: [
-        .external(name: "Alamofire"),
-        .external(name: "Moya"),
-        .external(name: "CombineMoya"),
-        .external(name: "Kingfisher"),
-        .external(name: "DGCharts"),
-        .external(name: "Lottie"),
-        // SwiftMacros depends on a Swift Macro, which is not yet supported.
-        //.external(name: "SwiftMacros")
     ],
     infoPlist: [
+        "CFBundleDisplayName": "$(XCC_PRODUCT_NAME)",
         "CFBundleShortVersionString": "$(MARKETING_VERSION)",
         "CFBundleVersion": "$(CURRENT_PROJECT_VERSION)",
-        "UIMainStoryboardFile": "",
-        "UILaunchStoryboardName": "LaunchScreen",
         "CFBundleName": "$(PRODUCT_NAME)",
         "CFBundleIdentifier": "$(PRODUCT_BUNDLE_IDENTIFIER)",
 
         // We need this to detect jail-broken device.
         "LSApplicationQueriesSchemes": ["cydia"],
 
+        "UILaunchScreen": [
+            "UILaunchScreen": []
+        ],
+
         "UIAppFonts": [
             "SF-Pro-Rounded-Black.otf",
             "SF-Pro-Rounded-Bold.otf",
@@ -77,7 +55,7 @@ let project = Project.app(
             "SF-Pro-Rounded-Ultralight.otf",
             "RobotoSlab-VariableFont.ttf"
         ],
-        
+
         "UIBackgroundModes": [
             "remote-notification"
         ],
@@ -91,9 +69,39 @@ let project = Project.app(
         "UIApplicationSupportsIndirectInputEvents": "TRUE",
 
         "NSCameraUsageDescription": "Record video",
-        "NSMicrophoneUsageDescription": "Record audio",
-
-        "CFBundleDisplayName": "$(XCC_PRODUCT_NAME)",
+        "NSMicrophoneUsageDescription": "Record audio"
+    ],
+    configInfoPlist: [
         "CONF_HOST_URL": "$(XCC_HOST_URL)"
-    ]
+    ],
+    modules: [
+        Module(
+            name: "Core",
+            hasResources: true,
+            hasUnitTest: true
+        ),
+        Module(
+            name: "CommonUI",
+            hasResources: true,
+            hasUITest: true,
+            dependencies: ["Core"]
+        ),
+        Module(
+            name: "Home",
+            hasUnitTest: true,
+            hasUITest: true,
+            dependencies: ["Core", "CommonUI"]
+        )
+    ],
+    externalDependencies: [
+        .external(name: "Alamofire"),
+        .external(name: "Moya"),
+        .external(name: "CombineMoya"),
+        .external(name: "Kingfisher"),
+        .external(name: "DGCharts"),
+        .external(name: "Lottie"),
+        // SwiftMacros depends on a Swift Macro, which is not yet supported.
+        // .external(name: "SwiftMacros")
+    ],
+    coreDataModels: []
 )

README.md

@@ -95,54 +95,118 @@ Total 3 playground related to date formatting. Inspired by [NSDateFormatter.com]
 
 ## Project Setup
 
+## Project Setup
+
 This project is using [Tuist](https://tuist.io). To run the project we need some initial setup.
 
-### Step 1: Install Tuist (One time setup)
+### Step 1: Install [mise](https://mise.jdx.dev/)
+
+We need `mise` to install `Tuist` and for maintaining project based `Tuist` versioning.
 
-Install Tuist using the following command:
+Install `mise` CLI:
 
 ```bash
-curl -Ls https://install.tuist.io | bash
+# Install CLI
+$ curl https://mise.jdx.dev/install.sh | sh
+
+# Check mise version
+$ ~/.local/bin/mise --version
+mise xxxx.x.x
+
+# Add mise to Zsh configuration file (`.zshrc`) for auto activate mise
+$ echo 'eval "$(~/.local/bin/mise activate zsh)"' >> ~/.zshrc
 ```
+Finally, restart your shell session to use `mise`.
 
-### Step 2: Fetch dependencies
+### Step 2: Install `Tuist`
+
+Install `Tuist` using the following command:
+
+```bash
+mise install tuist
+```
 
-We need to fetch the app dependencies. So use the following command to fetch the dependencies using Tuist.
+### Step 3: Clone repository and change directory to the repository
+
+```bash
+git clone git@github.pie.apple.com:RDDM/MyStore.git
+cd MyStore
+```
+
+### Step 4: Fetch dependencies
+
+We need to fetch the app dependencies. So use the following command to fetch the dependencies using `Tuist`.
 
 ```bash
 tuist fetch
 ```
 
 ### Step 3: Generate the project
 
-Finally, create the project file using the following command:
+Finally, generate and open the project using the following command:
 
 ```bash
 tuist generate
 ```
 
-This will generate the project file and run the project in Xcode.
+This will generate the project file and open the project in Xcode.
 
 ### Notes
 
-- As we are using Tuist to manage our Xcode project, use the following command to open the Tuist manifest files in Xcode for editing:
+- As we are using `Tuist` to manage our Xcode project, use the following command to open the Tuist manifest files in Xcode for editing:
 
 ```bash
 tuist edit
 ```
 
-- We have to run the `tuist fetch` every time we add or update dependency to our project.
+- We have to run the `tuist fetch` every time we change any dependency of our project.
+
+- To upgrade dependency versions, use `tuist fetch --update` command.
+
+- Always use `tuist generate` to open the project.
 
 - After changing branch we also need to run the `tuist generate` command to generate project files.
 
 - Please don't use Xcode Source Control. ([Issue](https://github.com/tuist/tuist/issues/4630))
 
-Please see the [Tuist documentation](https://docs.tuist.io/tutorial/get-started) for details.
+Please see the [Tuist documentation](https://docs.tuist.io) for details.
 
 ## Project Map
 
 ![Project Map](graph.png)
 
+## Directory Structure
+
+- `Root`: Root directory
+    - `ConfigurationFiles`: Configuration files
+    - `CoreData`: Core Data models
+    - `Entitlements`: Entitlements
+    - `Targets`: Targets/Modules
+        - `ModuleX`: An example target/module
+            - `Resources`: Resource of `ModuleX`
+            - `Sources`: Source codes of `ModuleX`
+                - `Models`: All models for `ModuleX`
+                    - **Note**: Keep models screen/sheet name wise.
+                - `UI`: All the UI files for `ModuleX`. It also contains `ViewModel`s.
+                    - `Components`: Common UI components that are shared in multiple screens
+                    - `Screens`: All screens, sheets etc.
+                        - `XYZ`: UI files for screen/sheet `XYZ`
+                            - `Components`: Common UI components for screen/sheet `XYZ`
+                                - `ABCView.swift`: Example component file
+                            - `XYZScreen.swift`: Example screen/sheet UI file
+                            - `XYZViewModel.swift`: Example view model file
+                - `ViewModels`: Common `ViewModel`s for `ModuleX`.
+            - `Tests`: Unit test target
+                - `Resources`: Resource of `Tests`
+                - `XYZTests.swift`: Example unit test file
+            - `UITests`: UI test target
+                - `Resources`: Resource of `UITests`
+                - `XYZUITests.swift`: Example UI test file
+        - `ModuleY`
+        - `ModuleZ`
+        - ...
+    - `Tuist`: Tuist configuration files
+
 # Tuist Cheat Sheet
 
 ## Access `Bundle`

Targets/CommonUI/Tests/BLANK_FILE.swift

@@ -5,18 +5,8 @@
 import ProjectDescription
 import ProjectDescriptionHelpers
 
-let packages: [Package] = [
-    .remote(url: "https://github.com/Alamofire/Alamofire", requirement: .upToNextMajor(from: "5.0.0")),
-    .remote(url: "https://github.com/Moya/Moya", requirement: .upToNextMajor(from: "15.0.0")),
-    .remote(url: "https://github.com/onevcat/Kingfisher", requirement: .upToNextMajor(from: "7.0.0")),
-    .remote(url: "https://github.com/danielgindi/Charts", requirement: .upToNextMajor(from: "5.0.0")),
-    .remote(url: "https://github.com/airbnb/lottie-ios", requirement: .upToNextMajor(from: "4.3.0")),
-    .local(path: "packages/SwiftMacros")
-]
-
 let dependencies = Dependencies(
     swiftPackageManager: .init(
-        packages,
         productTypes: [
             "Alamofire": .framework,
             "Moya": .framework,
@@ -27,9 +17,8 @@ let dependencies = Dependencies(
             "SwiftMacros": .framework
         ],
         baseSettings: Settings.settings(
-            configurations: TargetBuildEnvironment.allConfigurations
-        ),
-        targetSettings: [:]
+            configurations: BuildEnvironment.getConfigurations(for: .target)
+        )
     ),
     platforms: [.iOS]
 )

Targets/Core/UITests/BLANK_FILE.swift

@@ -0,0 +1,19 @@
+// swift-tools-version: 5.8
+
+//
+//  Copyright © 2023 Md. Mahmudul Hasan Shohag. All rights reserved.
+//
+
+import PackageDescription
+
+let package = Package(
+    name: "PackageName",
+    dependencies: [
+        .package(url: "https://github.com/Alamofire/Alamofire", from: "5.0.0"),
+        .package(url: "https://github.com/Moya/Moya", from: "15.0.0"),
+        .package(url: "https://github.com/onevcat/Kingfisher", from: "7.0.0"),
+        .package(url: "https://github.com/danielgindi/Charts", from: "5.0.0"),
+        .package(url: "https://github.com/airbnb/lottie-ios", from: "4.3.0"),
+        .package(path: "packages/SwiftMacros")
+    ]
+)

Tuist/Dependencies.swift

@@ -7,9 +7,10 @@ import ProjectDescription
 let appExtensions = [
     Target(
         name: "NotificationServiceExtension",
-        platform: .iOS,
+        destinations: [.iPhone, .iPad, .macWithiPadDesign, .appleVisionWithiPadDesign],
         product: .appExtension,
         bundleId: "\(Constants.bundleId).NotificationServiceExtension",
+        deploymentTargets: .iOS("17.0"),
         infoPlist: .extendingDefault(with: [
             "CFBundleDisplayName": "$(PRODUCT_NAME)",
             "NSExtension": [
@@ -20,7 +21,7 @@ let appExtensions = [
         sources: "NotificationServiceExtension/**",
         dependencies: [],
         settings: .settings(
-            configurations: NotificationServiceExtBuildEnvironment.allConfigurations
+            configurations: BuildEnvironment.getConfigurations(for: .notificationServiceExtension)
         )
     )
 ]