插件

插件是一种在多个项目之间共享和复用 Tuist 构件的工具。支持以下构件：

请注意，插件旨在提供一种简单的方式来扩展 Tuist 的功能。因此，有一些限制需要考虑：

插件不能依赖其他插件。
插件不能依赖第三方 Swift 包
插件不能使用使用该插件的项目中的项目描述辅助方法。

如果你需要更高的灵活性，可以考虑为工具提出功能建议，或者基于 Tuist 的生成框架 TuistGenerator 构建你自己的解决方案。

插件类型#

项目描述辅助方法插件#

项目描述辅助方法插件由一个目录表示，该目录包含声明插件名称的 Plugin.swift 清单文件，以及包含辅助 Swift 文件的 ProjectDescriptionHelpers 目录。

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
└── ...

模板的名称是资源类型的驼峰式命名版本：

资源类型	模板文件名
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-<task-name> 命名约定，则可以通过 tuist 命令调用。在早期版本中，Tuist 在 tuist plugin 下提供了一些较弱的约定和工具，用于表示 Swift 包中可执行文件的 build、run、test 和 archive 任务，但由于这会增加工具的维护负担和复杂性，我们已弃用此功能。

如果你之前使用 Tuist 来分发任务，我们建议你构建自己的

你可以继续使用每个 Tuist 版本附带的 ProjectAutomation.xcframework，通过 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)