mago

MAGO：氧化的PHP工具鏈

Mago （源自Mago（Punic：???，MGN），著名的迦太基人物）是PHP的工具鏈，旨在提供一組工具來幫助開發人員編寫更好的代碼。 Mago從Rust編程語言及其生態系統中汲取靈感，努力為PHP世界帶來類似的便利性，可靠性和出色的開發人員體驗。

---

注意：此項目以前被稱為“ Fennec”，然後由於命名衝突而被重新命名。

免責聲明

警告

Mago正處於發展的早期階段。尚未實現許多功能，現有功能可能會改變，中斷或停止工作而無需通知。雖然我們沒有積極促進或宣傳該項目，但我們在公開場合與社區分享我們的進步。

安裝

單行安裝（建議）

要快速安裝用於MacOS或Linux的MAGO的最新版本，請使用以下命令：

使用curl ：

curl --proto ' =https ' --tlsv1.2 -sSf https://carthage.software/mago.sh | bash

使用wget ：

wget -qO- https://carthage.software/mago.sh | bash

自定義安裝目錄

要指定二進制的自定義目錄，請使用 - 安裝 - dir選項：

curl --proto ' =https ' --tlsv1.2 -sSf https://carthage.software/mago.sh | bash -s -- --install-dir= " /.bin "

如果目錄不在您的PATH中，則該腳本將提供添加它的說明。

使用sudo安裝

如果您需要在整個系統範圍內安裝MAGO，則可以將sudo與安裝命令一起使用：

curl --proto ' =https ' --tlsv1.2 -sSf https://carthage.software/mago.sh | sudo bash

預編譯的二進製文件

您可以在我們的版本頁面上找到各種平台的預編譯二進製文件。只需為您的平台下載檔案，提取它，然後將mago二進制放在PATH中。

通過貨物安裝

如果安裝了生鏽，則可以使用貨物安裝MAGO：

cargo install mago

從源安裝

要從源安裝mago，您可以克隆存儲庫並使用貨物構建項目：

git clone https://github.com/carthage-software/mago
cd mago
cargo install --path . 

PHP版本兼容性

目前， Mago建於PHP 8.3左右，也支持PHP 8.4。雖然Linter和Formatter可能與早期版本的PHP一起使用，但我們不能保證兼容性。他們可能建議修復或編寫僅與PHP 8.3及以後兼容的代碼。

在此階段，沒有選擇選擇PHP版本目標，這意味著MAGO在現代PHP版本的假設下運行。將來，我們計劃引入選擇PHP版本目標的支持。實施後，此功能應使與早期的PHP版本具有更好的兼容性，並有可能降至PHP 8.0甚至更早。

如果您在8.3之前使用PHP版本，請謹慎並查看建議的修復程序或格式的代碼，以確保與您的版本兼容。

用法

對於快速啟動，您可以參考提供的示例配置文件：

• 簡單配置： examples/mago.toml
• 具有所有可能選項的完整配置： examples/mago-full.toml

您可以通過導航到examples目錄並在示例PHP文件上運行Linter來嘗試MAGO：

 cd examples
mago lint
mago fmt

這將分析examples/src/ Directory中的PHP文件，並顯示任何覆蓋錯誤。

您如何提供幫助

Mago是一個社區驅動的項目，我們希望您能加入我們！以下是您可以做出貢獻的一些方法：

• 建議想法：對Mago有一個想法嗎？我們願意提出可以使工具鏈更好的建議！
• 幫助編寫文檔：清晰，用戶友好的文檔是使每個人都可以訪問mago的關鍵。如果您喜歡寫或組織文檔，我們會很喜歡您的幫助。
• 貢獻代碼：加入我們建立Mago！請先討論問題中的任何功能或錯誤修復，以確保我們有效地協調。
• 贊助項目：如果您想在財務上支持Mago，請考慮贊助@Azjezz。每個貢獻都會有所幫助！
• 幫助藝術：Mago可以使用徽標！我們將感謝一位熟練的藝術家的幫助，為Mago創建原始徽標。 （請注意，AI生成的藝術將不會被接受。）

加入Mago社區

有問題，反饋或想法？加入Mago社區的不和諧，與其他開發人員建立聯繫並保持最新狀態。

加入這裡

靈感

Mago的靈感來自幾種為開發社區做出重大貢獻的工具和項目：

• Clippy：一系列棉絨，以捕獲常見的錯誤並改善您的鏽蝕代碼。
• OXC：用生鏽寫的JavaScript工具鏈。
• PHP-Rust-Tools/Parser：用Rust寫的PHP解析器，這影響了我們的解析方法。
• Slackhq/hakana：由詩篇的創建者編寫的Hacklang的靜態分析工具。

這些工具激發了我們的啟發，並幫助塑造了Mago的設計和功能。

致謝

我們要承認以下以下PHP工具，這些工具在旅途中大大幫助了數十萬PHP開發人員：我們自己包括：

• PHP CS修復程序：一種自動修復PHP編碼標準問題的工具。
• 詩篇：用於在PHP應用中查找錯誤的靜態分析工具。
• PHPSTAN：PHP靜態分析工具。
• php_codesniffer：檢測違反定義的編碼標準集。

儘管Mago打算成為一個最終可以取代其中一些工具的綜合工具鏈，但我們非常感謝他們為PHP社區建立的貢獻和基礎。

執照

Mago在任何一個下都獲得了許可

• 麻省理工學院許可證（MIT） - 有關詳細信息，請參見許可證文件
• Apache許可證，版本2.0（Apache-2.0） - 有關詳細信息，請參見許可證文件

可以選擇。

貢獻

除非您另有明確說明，否則任何有意提交的捐款被您納入Mago，均應在上述雙重許可中，沒有任何其他條款或條件。

---

感謝您對Mago的興趣。隨著項目的發展，我們期待分享我們的進步並與社區合作。