გადადით შინაარსზე

პლაგინები

პლაგინები არის ინსტრუმენტი Tuist-ის არტეფაქტების გასაზიარებლად და ხელახლა გამოსაყენებლად რამდენიმე პროექტში. მხარდაჭერილია შემდეგი არტეფაქტები:

გაითვალისწინეთ, რომ პლაგინები შექმნილია Tuist-ის ფუნქციონალის გასაფართოებლად მარტივი გზით. შესაბამისად, არსებობს გარკვეული შეზღუდვები, რომლებიც უნდა გაითვალისწინოთ:

  • პლაგინს არ შეუძლია იყოს დამოკიდებული სხვა პლაგინზე.
  • პლაგინს არ შეუძლია იყოს დამოკიდებული მესამე მხარის Swift პაკეტებზე
  • პლაგინს არ შეუძლია გამოიყენოს პროექტის აღწერის დამხმარეები იმ პროექტიდან, რომელიც იყენებს ამ პლაგინს.

თუ მეტი მოქნილობა გჭირდებათ, განიხილეთ ინსტრუმენტისთვის ფუნქციის შეთავაზება ან საკუთარი გადაწყვეტის აგება Tuist-ის გენერაციის ჩარჩოზე, TuistGenerator.

პლაგინების ტიპები#

პროექტის აღწერის დამხმარე პლაგინი#

პროექტის აღწერის დამხმარე პლაგინი წარმოდგენილია დირექტორიით, რომელიც შეიცავს Plugin.swift მანიფესტის ფაილს პლაგინის სახელის განსაცხადად და ProjectDescriptionHelpers დირექტორიას დამხმარე Swift ფაილებით.

bash
import ProjectDescription
let plugin = Plugin(name: "MyPlugin")
bash
.
├── ...
├── Plugin.swift
├── ProjectDescriptionHelpers
└── ...

რესურსებზე წვდომის შაბლონების პლაგინი#

თუ გსურთ სინთეზირებული რესურსებზე წვდომის გაზიარება, შეგიძლიათ გამოიყენოთ ამ ტიპის პლაგინი. პლაგინი წარმოდგენილია დირექტორიით, რომელიც შეიცავს Plugin.swift მანიფესტის ფაილს პლაგინის სახელის განსაცხადად და ResourceSynthesizers დირექტორიას რესურსებზე წვდომის შაბლონის ფაილებით.

bash
import ProjectDescription
let plugin = Plugin(name: "MyPlugin")
bash
.
├── ...
├── Plugin.swift
├── ResourceSynthesizers
├───── Strings.stencil
├───── Plists.stencil
├───── CustomTemplate.stencil
└── ...

შაბლონის სახელი არის რესურსის ტიპის camel case ვერსია:

რესურსის ტიპი შაბლონის ფაილის სახელი
Strings Strings.stencil
Assets Assets.stencil
Property Lists Plists.stencil
Fonts Fonts.stencil
Core Data CoreData.stencil
Interface Builder InterfaceBuilder.stencil
JSON JSON.stencil
YAML YAML.stencil

როდესაც პროექტში განსაზღვრავთ რესურსების სინთეზატორებს, შეგიძლიათ მიუთითოთ პლაგინის სახელი პლაგინიდან შაბლონების გამოყენებისთვის:

swift
let project = Project(resourceSynthesizers: [.strings(plugin: "MyPlugin")])

ამოცანის პლაგინი #

მოძველებულია

ამოცანის პლაგინები მოძველებულია. თუ პროექტისთვის ავტომატიზაციის გადაწყვეტას ეძებთ, იხილეთ ეს ბლოგ-პოსტი.

ამოცანები არის $PATH-ში ხელმისაწვდომი შესრულებადი ფაილები, რომლებიც გამოიძახება tuist ბრძანებით, თუ ისინიც იცავენ სახელდების კონვენციას tuist-<task-name>. ადრეულ ვერსიებში Tuist უზრუნველყოფდა ზოგიერთ სუსტ კონვენციას და ინსტრუმენტებს tuist plugin ქვეშ build, run, test და archive ამოცანებისთვის, რომლებიც წარმოდგენილი იყო Swift Packages-ში შესრულებადი ფაილებით, მაგრამ ჩვენ ეს ფუნქცია მოვაძველეთ, რადგან ის ზრდის ინსტრუმენტის შენარჩუნების ტვირთს და სირთულეს.

თუ ამოცანებს პლაგინებად ავრცელებდით, ნაცვლად ამისა ააწყეთ ისინი როგორც დამოუკიდებელი შესრულებადი ფაილები:

  • შეგიძლიათ განაგრძოთ ProjectAutomation.xcframework-ის გამოყენება, რომელიც ვრცელდება ყოველ Tuist გამოცემასთან ერთად, რათა თქვენს ლოგიკაში გქონდეთ წვდომა პროექტის გრაფზე let graph = try Tuist.graph()-ის მეშვეობით. ის ასრულებს tuist-ს როგორც შვილობილ პროცესს და აბრუნებს პროექტის გრაფის წარმოდგენას მეხსიერებაში.
  • ამოცანების გასავრცელებლად, ჩვენ გირჩევთ GitHub-ის გამოცემებში გამოაქვეყნოთ უნივერსალური ბინარი, რომელიც მხარს უჭერს arm64-ს და x86_64-ს, და გამოიყენოთ Mise როგორც ინსტალაციის ინსტრუმენტი. იმისთვის, რომ Mise-ს მიანიჭოთ თქვენი ინსტრუმენტის ინსტალაციის ინსტრუქცია, დაგჭირდებათ პლაგინის რეპოზიტორი. შეგიძლიათ გამოიყენოთ Tuist-ის რეპოზიტორი როგორც ნიმუში.
  • თუ თქვენს ინსტრუმენტს დაარქმევთ tuist-{xxx} და მომხმარებლებს შეეძლებათ მისი ინსტალაცია mise install-ის გაშვებით, მათ შეუძლიათ მისი გაშვება ან პირდაპირი გამოძახებით, ან tuist xxx-ის მეშვეობით.
ProjectAutomation-ის მომავალი

ჩვენ ვგეგმავთ ProjectAutomation-ის და XcodeGraph-ის მოდელების გაერთიანებას ერთ უკუთავსებად ჩარჩოში, რომელიც მომხმარებელს უჩვენებს პროექტის გრაფის სრულ სურათს. გარდა ამისა, გენერაციის ლოგიკას გამოვყოფთ ახალ შრეში, XcodeGraph, რომლის გამოყენებაც შეგიძლიათ თქვენი საკუთარი CLI-დან. წარმოიდგინეთ ეს როგორც თქვენი საკუთარი Tuist-ის აწყობა.

პლაგინების გამოყენება#

პლაგინის გამოსაყენებლად, თქვენ უნდა დაამატოთ ის თქვენი პროექტის Tuist.swift მანიფესტის ფაილში:

swift
import ProjectDescription
let tuist = Tuist(
project: .tuist(plugins: [
.local(path: "/Plugins/MyPlugin")
])
)

თუ გსურთ პლაგინის ხელახლა გამოყენება სხვადასხვა რეპოზიტორიაში მყოფ პროექტებში, შეგიძლიათ ატვირთოთ თქვენი პლაგინი Git რეპოზიტორიაში და მიუთითოთ იგი Tuist.swift ფაილში:

swift
import ProjectDescription
let tuist = Tuist(
project: .tuist(plugins: [
.git(url: "https://url/to/plugin.git", tag: "1.0.0"),
.git(url: "https://url/to/plugin.git", sha: "e34c5ba")
])
)

პლაგინების დამატების შემდეგ, tuist install ჩამოტვირთავს პლაგინებს გლობალურ ქეშის დირექტორიაში.

ვერსიების გარჩევის არარსებობა

როგორც შეამჩნიეთ, ჩვენ არ ვუზრუნველყოფთ პლაგინების ვერსიების გარჩევას. განმეორებადობის უზრუნველსაყოფად გირჩევთ Git ტეგების ან SHA-ების გამოყენებას.

პროექტის აღწერის დამხმარე პლაგინები

როდესაც იყენებთ პროექტის აღწერის დამხმარე პლაგინს, მოდულის სახელი, რომელიც შეიცავს დამხმარეებს, არის პლაგინის სახელი

swift
import ProjectDescription
import MyTuistPlugin
let project = Project.app(name: "MyCoolApp", platform: .iOS)