tuhin18003/fix-translators-comments

A PHP package to automatically add translators' comments in WordPress localization code using ChatGPT.

v1.1.0 2024-10-02 13:52 UTC

Requires

• php: ^7.4 || ^8.0
• guzzlehttp/guzzle: ^7.0
• openai-php/client: ^0.1

MIT

• M. Tuhin

README

This package automatically adds translators' comments to your WordPress localization strings using ChatGPT.

Installation

Run the following command to install via Composer:

composer require tuhin18003/fix-translators-comments

Usage

Once the package is installed, you can run the command to fix translators' comments in your WordPress localization files.

Command

You can run the command using Composer as follows:

composer run-script fix-translators-comments --openApiKey=<YOUR_API_KEY> --directory=<DIRECTORY_PATH>

Parameters

• openApiKey: Your OpenAI API key to authenticate requests.
• directory: The path to the directory containing the files you want to process.

Example Usages

1. Using a specific API key and directory:

If your OpenAI API key is exampleApiKey and you want to process files in the /test directory, the command will look like this:

composer run-script fix-translators-comments --openApiKey=exampleApiKey --directory=/test

2. Processing files in the current directory:

If you want to process files in the current directory, you can simply run:

composer run-script fix-translators-comments --openApiKey=exampleApiKey --directory=.

3. Checking the usage:

If you need to check the command usage and parameters, you can use:

composer run-script fix-translators-comments

4. In your project's composer.json - scripts

If you want to process files in the /test directory, the command will look like this:

"scripts": {
      "fixTranslatorsComments": "php ./vendor/tuhin18003/fix-translators-comments/src/FixTranslatorsCommand.php --openApiKey=exampleApiKey --directory=./test"
  }

you want to process a single file, the command will look like this:

"scripts": {
      "fixTranslatorsComments": "php ./vendor/tuhin18003/fix-translators-comments/src/FixTranslatorsCommand.php --openApiKey=exampleApiKey --directory=./test/filename.php"
  }

Then on the terminal run:

composer run fixTranslatorsComments

Result Summary:

Sample Comment added on file:

Credentials

• Created by - M.Tuhin