aboks/php-src-devtools

使用 Docker 使构建、运行和测试 PHP 源代码更加容易的工具

v0.0.2 2018-05-13 14:58 UTC

This package is auto-updated.

Last update: 2024-09-13 20:42:18 UTC


README

Latest Stable Version

🐘 php-src-devtools 🐳

使贡献 PHP 本身更加容易的工具(php-src)。使用 Docker 容器构建、运行和测试 PHP 源代码。

$ composer global require aboks/php-src-devtools
$ git clone https://github.com/php/php-src.git && cd php-src
# write a test, or make your own changes to PHP
$ php-src-devtools test

为什么?

尽管有繁荣的 PHP 开源社区,但只有极少数人向 PHP 本身做出贡献。这可以部分解释为:向 PHP 内部做出贡献与向 PHP 项目做出贡献有很大不同:它使用不同的语言(C 而不是 PHP)、不同的工具和不同的工作流程。

该项目旨在消除一些障碍,使 PHP 开发者成为 PHP 核心开发者

  • 在 Docker 容器内编译和测试 PHP 可以消除安装任何构建依赖的需求,这可以避免系统混乱或不易在您的操作系统上获得。特别是,它为 Windows 用户提供了极大地简化了入门路径。
  • 大多数 PHP 开发者将习惯于使用 Composer 安装此类工具。
  • 使用 PHP 开发者可能已经使用的工具(Symfony Console 和 Docker)提供了一种熟悉的经验。
  • 控制台应用程序将一些必要的构建步骤抽象出来,并使可能的操作可发现。

有关向 PHP 做出贡献的更多信息,请参阅我 "开始 PHP 核心开发" 会议演讲的幻灯片。

先决条件

确保 Docker 已安装在您的系统上并正在运行。

安装

安装此工具的最简单方法是将其作为全局 composer 包安装

$ composer global require aboks/php-src-devtools

或者,在某个位置克隆或下载此存储库,运行 composer install 以安装依赖项,并确保 php-src-devtools 在您的 PATH 中。

使用方法

在包含您克隆的 php-src 的文件夹中运行

  • php-src-devtools build 构建 PHP。请注意,初始构建可能需要大约一个小时。
  • php-src-devtools test 运行完整的 PHP 测试套件。您可以使用 php-src-devtools test path/to/test.phpt 运行单个测试,或者 php-src-devtools test ext/foo 测试单个扩展。
  • php-src-devtools php 运行编译后的 PHP CLI,例如 php-src-devtools php -i 查看phpinfo。
  • php-src-devtools list 查看所有子命令,或 php-src-devtools help 获取更多帮助。

状态

此工具仍处于相当实验性的阶段,但基本功能,如从源代码构建 PHP 和运行测试应能正常工作。请试用并报告您遇到的任何问题和可能的改进。欢迎拉取请求。

版本控制

本项目遵循 语义版本控制

许可证

代码在 MIT 许可证下发布。