安裝 Gradle 外掛程式

Tuist 提供一個 Gradle 外掛程式，可與你的 Gradle 專案整合，以啟用如遠端建構快取和建構洞察等功能。本指南將帶你逐步完成外掛程式的安裝與設定。

此外掛程式需要 Gradle 8.12.1 或更新版本。

1. 初始化 Tuist#

在你的 Gradle 專案根目錄執行以下指令：

bash

mise x tuist@latest -- tuist init

bash

tuist init

該指令會引導你完成驗證、建立或選擇 Tuist 專案，以及為你的 Gradle 專案產生設定檔。

執行 tuist init 後，你需要按照指令輸出的指示，將 Tuist 外掛程式加入至你的 settings.gradle.kts：

kotlin

plugins {
    id("dev.tuist") version "0.10.0"
}

雖然 tuist init 會在本地驗證你的身份，但你的隊友和持續整合環境需要 separately 進行驗證。

每位隊友都應執行以下指令，以便在其機器上存取 Tuist 功能：

bash

tuist auth login

當你使用自託管或本地 Tuist 伺服器時，請傳入與 tuist.toml 中設定的相同基礎 URL：

bash

tuist auth login --url http://localhost:8080
tuist auth whoami --url http://localhost:8080

保持主機名稱拼寫一致。例如，為 localhost 儲存的登入資訊與為 127.0.0.1 儲存的登入資訊是分開的。

對於自動化執行器，請參閱持續整合驗證指南，以設定適合你環境的驗證方式。

此外掛程式支援 Gradle 的設定快取和隔離專案。請將外掛程式保留在 settings.gradle.kts；你無需將其分別套用到每個子專案。

Tuist 不會自動啟用任一功能。若要選用，請將以下内容加入至 gradle.properties：

plaintext

org.gradle.configuration-cache=true
org.gradle.unsafe.isolated-projects=true

你的建構腳本和其他外掛程式也必須支援這些功能。Gradle 會在儲存設定快取時報告相容性問題。

以下選項可在 settings.gradle.kts 中的 tuist 擴充區塊中使用：

選項	類型	預設值	說明
`project`	`String?`	`null`（選填）	採用 `account/project` 格式的專案識別碼。若未設定，外掛程式會從 `tuist.toml` 讀取。
`url`	`String?`	`null`	Tuist 伺服器的基礎 URL。若未設定，則預設為 `"https://tuist.dev"` 或 `tuist.toml` 中定義的值。
`uploadInBackground`	`Boolean?`	`null`	是否在背景上傳建構和測試洞察資料。當為 `null`（預設值）時，本地建構會在背景上傳，而持續整合執行器則在前台上傳。
`stressNewTests.mode`	`String?`	`null`	`"report"` 或 `"enforce"`。重新執行建構新增的測試案例，並標記任何證明不穩定的案例；詳見壓力測試新測試。未設定時為關閉狀態。

對於使用 http:// URL 的本地伺服器，僅在該本地設定中允許不安全協定：

kotlin

tuist {
    buildCache {
        allowInsecureProtocol = true
    }
}

請勿為託管或其他 https:// 伺服器啟用 allowInsecureProtocol。

Tuist.toml

建議透過專案根目錄中的 tuist.toml 檔案來設定 project（以及選填的 url）。這樣一來，Tuist 命令列介面和 Gradle 外掛程式即可共用設定。如有需要，你仍可在 settings.gradle.kts 中覆寫這些值。

toml

project = "account/project"
url = "https://tuist.dev"

如果你的網路透過 HTTP 代理伺服器路由出站流量，請參閱 HTTP 代理伺服器指南。

安裝並設定好外掛程式後，你可以啟用：