acseo/ai-phpunit

使用 GPT-4 添加缺失的 PHPUnit 测试。

dev-main 2024-08-17 12:09 UTC

This package is auto-updated.

Last update: 2024-09-17 12:18:04 UTC


README

AI PHPUnit 是一个工具,使用 GPT-4 自动将缺失的 PHPUnit 测试添加到您的 PHP 代码中。

先决条件

本包使用 OpenAI API。在使用 AI PHPUnit 之前,您需要设置一个 OpenAI API 密钥作为环境变量。

export OPENAI_KEY=...

安装

要安装 AI PHPUnit,运行以下命令

composer global require acseo/ai-phpunit

使用方法

要将缺失的 PHPUnit 注释添加到单个文件中,使用以下命令

aiphpunit file  /path/to/file.php

要将缺失的 PHPUnit 测试添加到文件的目录中,使用以下命令。默认情况下,它会遍历当前目录中的所有文件,但不进入子目录

aiphpunit dir

您可以使用 --recursive 标志或 -r 短标志使其进入子目录。

如果您传递另一个变量(无论是否设置递归标志),它将将其视为另一个要扫描的目录,而不是工作目录。

aiphpunit dir -r /somewhere/else

Docker 使用

您可以使用 Docker 图像 acseo/ai-phpunit 通过 Docker 使用 ai-phpunit

$ docker run -it -e OPENAI_KEY=sk-xxx -v /path/to/your/code:/code acseo/ai-phpunit dir -r /code/src

许可协议

AI PHPUnit 根据 AGPL-3.0 许可协议授权。有关更多信息,请参阅 LICENSE。

它受到 ai-phpdoc 的启发