ترحيل مشروع Xcode

ما لم تقم بإنشاء مشروع جديد باستخدام تويست ، وفي هذه الحالة ستحصل على كل شيء مهيأ تلقائيًا، سيكون عليك تحديد مشاريع Xcode الخاصة بك باستخدام أساسيات تويست. يعتمد مدى ملل هذه العملية على مدى تعقيد مشاريعك.

كما تعلم على الأرجح، يمكن أن تصبح مشاريع Xcode فوضوية ومعقدة بمرور الوقت: مجموعات لا تتطابق مع بنية الدليل، أو ملفات مشتركة بين الأهداف، أو مراجع ملفات تشير إلى ملفات غير موجودة (على سبيل المثال لا الحصر). كل هذه التعقيدات المتراكمة تجعل من الصعب علينا توفير أمر يقوم بترحيل المشروع بشكل موثوق.

علاوة على ذلك، فإن الترحيل اليدوي هو تمرين ممتاز لتنظيف مشاريعك وتبسيطها. لن يكون المطورون في مشروعك وحدهم ممتنين لذلك، بل سيكون Xcode أيضًا ممتنًا لذلك، حيث سيعمل على معالجتها وفهرستها بشكل أسرع. بمجرد أن تتبنى Tuist بالكامل، ستحرص على أن يتم تعريف المشاريع بشكل متسق وأن تظل بسيطة.

بهدف تسهيل هذا العمل، نقدم لك بعض الإرشادات بناءً على الملاحظات التي تلقيناها من المستخدمين.

إنشاء سقالة المشروع

أولاً، قم بإنشاء سقالة لمشروعك باستخدام ملفات Tuist التالية:

:::: مجموعة الرموز

import ProjectDescription

let tuist = Tuist()

import ProjectDescription

let project = Project(
    name: "MyApp-Tuist",
    targets: [
        /** Targets will go here **/
    ]
)

// swift-tools-version: 5.9
import PackageDescription

#if TUIST
    import ProjectDescription

    let packageSettings = PackageSettings(
        // Customize the product types for specific package product
        // Default is .staticFramework
        // productTypes: ["Alamofire": .framework,]
        productTypes: [:]
    )
#endif

let package = Package(
    name: "MyApp",
    dependencies: [
        // Add your own dependencies here:
        // .package(url: "https://github.com/Alamofire/Alamofire", from: "5.0.0"),
        // You can read more about dependencies here: https://docs.tuist.io/documentation/tuist/dependencies
    ]
)

:::

Project.swift.swift هو ملف البيان حيث ستحدد مشروعك، و Package.swift هو ملف البيان حيث ستحدد تبعياتك. ملف Tuist.swift.swift هو الملف الذي يمكنك من خلاله تحديد إعدادات Tuist على نطاق المشروع لمشروعك.

PROJECT NAME WITH -TUIST SUFFIX

لمنع التعارض مع مشروع Xcode الحالي، نوصي بإضافة لاحقة -Tuist إلى اسم المشروع. يمكنك إسقاطها بمجرد ترحيل مشروعك بالكامل إلى Tuist.

إنشاء واختبار مشروع تويست في CI

للتأكد من صحة ترحيل كل تغيير، نوصي بتوسيع نطاق التكامل المستمر لبناء واختبار المشروع الذي تم إنشاؤه بواسطة Tuist من ملف البيان الخاص بك:

tuist install
tuist generate
xcodebuild build {xcodebuild flags} # or tuist test

استخرج إعدادات بناء المشروع إلى ملفات .xcconfig

استخرج إعدادات الإنشاء من المشروع إلى ملف .xcconfig لجعل المشروع أكثر مرونة وأسهل في الترحيل. يمكنك استخدام الأمر التالي لاستخراج إعدادات الإنشاء من المشروع إلى ملف .xcconfig:

mkdir -p xcconfigs/
tuist migration settings-to-xcconfig -p MyApp.xcodeproj -x xcconfigs/MyApp-Project.xcconfig

ثم قم بتحديث ملف Project.swift.swift الخاص بك للإشارة إلى ملف .xcconfig الذي قمت بإنشائه للتو:

import ProjectDescription

let project = Project(
    name: "MyApp",
    settings: .settings(configurations: [
        .debug(name: "Debug", xcconfig: "./xcconfigs/MyApp-Project.xcconfig"), 
        .release(name: "Release", xcconfig: "./xcconfigs/MyApp-Project.xcconfig"), 
    ]),
    targets: [
        /** Targets will go here **/
    ]
)

ثم قم بتوسيع خط أنابيب التكامل المستمر لتشغيل الأمر التالي لضمان إجراء التغييرات على إعدادات الإنشاء مباشرةً إلى ملفات .xcconfig:

tuist migration check-empty-settings -p Project.xcodeproj

استخراج تبعيات الحزمة

استخرج جميع تبعيات مشروعك في ملف Tuist/Package.swift.swift:

// swift-tools-version: 5.9
import PackageDescription

#if TUIST
    import ProjectDescription

    let packageSettings = PackageSettings(
        // Customize the product types for specific package product
        // Default is .staticFramework
        // productTypes: ["Alamofire": .framework,]
        productTypes: [:]
    )
#endif

let package = Package(
    name: "MyApp",
    dependencies: [
        // Add your own dependencies here:
        // .package(url: "https://github.com/Alamofire/Alamofire", from: "5.0.0"),
        // You can read more about dependencies here: https://docs.tuist.io/documentation/tuist/dependencies
        .package(url: "https://github.com/onevcat/Kingfisher", .upToNextMajor(from: "7.12.0")) 
    ]
)

PRODUCT TYPES

يمكنك تجاوز نوع المنتج لحزمة معينة عن طريق إضافته إلى قاموس productTypes في PackageSettings structure. يفترض تويست افتراضيًا أن جميع الحزم هي أطر عمل ثابتة.

تحديد ترتيب الترحيل

نوصي بترحيل الأهداف من الأكثر اعتمادًا إلى الأقل اعتمادًا. يمكنك استخدام الأمر التالي لسرد أهداف مشروع ما، مرتبة حسب عدد التبعيات:

tuist migration list-targets -p Project.xcodeproj

ابدأ بترحيل الأهداف من أعلى القائمة، لأنها الأكثر اعتمادًا عليها.

ترحيل الأهداف

ترحيل الأهداف واحدًا تلو الآخر. نوصي بإجراء طلب سحب لكل هدف لضمان مراجعة التغييرات واختبارها قبل دمجها.

استخرج إعدادات بناء الهدف إلى ملفات .xcconfig

كما فعلت مع إعدادات بناء المشروع، استخرج إعدادات بناء الهدف في ملف .xcconfig لجعل الهدف أكثر مرونة وأسهل في الترحيل. يمكنك استخدام الأمر التالي لاستخراج إعدادات البناء من الهدف إلى ملف .xcconfig:

tuist migration settings-to-xcconfig -p MyApp.xcodeproj -t TargetX -x xcconfigs/TargetX.xcconfig

حدد الهدف في ملف Project.swift.swift

حدد الهدف في Project.targets:

import ProjectDescription

let project = Project(
    name: "MyApp",
    settings: .settings(configurations: [
        .debug(name: "Debug", xcconfig: "./xcconfigs/Project.xcconfig"),
        .release(name: "Release", xcconfig: "./xcconfigs/Project.xcconfig"),
    ]),
    targets: [
        .target( 
            name: "TargetX", 
            destinations: .iOS, 
            product: .framework, // [!code ++] // or .staticFramework, .staticLibrary...
            bundleId: "dev.tuist.targetX", 
            sources: ["Sources/TargetX/**"], 
            dependencies: [ 
                /** Dependencies go here **/
                /** .external(name: "Kingfisher") **/
                /** .target(name: "OtherProjectTarget") **/
            ], 
            settings: .settings(configurations: [ 
                .debug(name: "Debug", xcconfig: "./xcconfigs/TargetX.xcconfig"), 
                .debug(name: "Release", xcconfig: "./xcconfigs/TargetX.xcconfig"), 
            ]) 
        ), 
    ]
)

TEST TARGETS

إذا كان للهدف هدف اختبار مرتبط، فيجب عليك تعريفه في ملف Project.swift. أيضًا بتكرار نفس الخطوات.

التحقق من صحة الترحيل المستهدف

قم بتشغيل tuist gener متبوعًا بـ xcodebuild build للتأكد من بناء المشروع، و tuist test للتأكد من اجتياز الاختبارات. بالإضافة إلى ذلك، يمكنك استخدام [xcdiff] (https://github.com/bloomberg/xcdiff) لمقارنة مشروع Xcode الذي تم إنشاؤه مع المشروع الحالي للتأكد من صحة التغييرات.

التكرار

كرر ذلك حتى يتم ترحيل جميع الأهداف بالكامل. بمجرد الانتهاء من ذلك، نوصي بتحديث خطوط أنابيب CI و CD الخاصة بك لبناء واختبار المشروع باستخدام tuist generate متبوعًا بـ xcodebuild build و tuist test.

استكشاف الأخطاء وإصلاحها

أخطاء التجميع بسبب الملفات المفقودة.

إذا لم تكن جميع الملفات المرتبطة بأهداف مشروع Xcode الخاص بك متضمنة في دليل نظام الملفات الذي يمثل الهدف، فقد ينتهي بك الأمر بمشروع لا يتم تجميعه. تأكد من تطابق قائمة الملفات بعد إنشاء المشروع باستخدام Tuist مع قائمة الملفات في مشروع Xcode، واغتنم الفرصة لمواءمة بنية الملفات مع بنية الهدف.