tuhin18003 / fix-translators-comments
一个PHP包,使用ChatGPT自动在WordPress本地化代码中添加翻译者注释。
v1.1.0
2024-10-02 13:52 UTC
Requires
- php: ^7.4 || ^8.0
- guzzlehttp/guzzle: ^7.0
- openai-php/client: ^0.1
This package is auto-updated.
Last update: 2024-10-02 21:32:27 UTC
README
此包会自动使用ChatGPT将翻译者注释添加到您的WordPress本地化字符串中。
安装
运行以下命令通过Composer安装
composer require tuhin18003/fix-translators-comments
使用方法
安装包后,您可以运行命令以修复WordPress本地化文件中的翻译者注释。
命令
您可以使用Composer运行以下命令
composer run-script fix-translators-comments --openApiKey=<YOUR_API_KEY> --directory=<DIRECTORY_PATH>
参数
- openApiKey: 用于验证请求的您的OpenAI API密钥。
- directory: 包含您要处理的文件的目录路径。
示例用法
1. 使用特定的API密钥和目录
如果您的OpenAI API密钥是 exampleApiKey
,并且您想要处理 /test
目录中的文件,命令将如下所示
composer run-script fix-translators-comments --openApiKey=exampleApiKey --directory=/test
2. 处理当前目录中的文件
如果您想要处理当前目录中的文件,您可以简单地运行
composer run-script fix-translators-comments --openApiKey=exampleApiKey --directory=.
3. 检查使用方法
如果您需要检查命令的使用方法和参数,可以使用
composer run-script fix-translators-comments
4. 在项目的composer.json中的 - scripts
如果您想要处理 /test
目录中的文件,命令将如下所示
"scripts": { "fixTranslatorsComments": "php ./vendor/tuhin18003/fix-translators-comments/src/FixTranslatorsCommand.php --openApiKey=exampleApiKey --directory=./test" }
如果您只想处理单个文件,命令将如下所示
"scripts": { "fixTranslatorsComments": "php ./vendor/tuhin18003/fix-translators-comments/src/FixTranslatorsCommand.php --openApiKey=exampleApiKey --directory=./test/filename.php" }
然后在终端运行
composer run fixTranslatorsComments
结果摘要
文件中添加的示例注释
凭证
- 由 M.Tuhin 创建