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的兴趣。随着项目的发展，我们期待分享我们的进步并与社区合作。