README

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require cargofy/laravel-ai-i18n

Публікація ресурсів

Ви можете опублікувати конфігураційний файл за допомогою:

php artisan vendor:publish --tag="laravel-ai-i18n-config"

Ви також можете опублікувати сервіс-провайдер для подальшої кастомізації:

php artisan vendor:publish --tag="laravel-ai-i18n-provider"

Ось вміст опублікованого конфігураційного файлу:

return [
    // The driver to use for translation
    'driver' => env('AI_TRANSLATION_DRIVER', 'chatgpt'),

    // Available translation services
    'services' => [
        // ChatGPT translation service
        'chatgpt' => [
            'api_key' => env('OPENAI_API_KEY'),
            'model' => env('OPENAI_MODEL', 'gpt-4o'),
            'temperature' => env('OPENAI_TEMPERATURE', 0.3),
        ],
        
        // You can add more services here in the future
        // 'google' => [
        //     'api_key' => env('GOOGLE_TRANSLATE_API_KEY'),
        // ],
    ],

    // Language settings
    'languages' => [
        // The source language code (ISO 639-1)
        'source' => 'en',
        
        // Target languages to translate to (array of ISO 639-1 codes)
        'targets' => ['uk', 'de', 'fr', 'es'],
    ],

    // Paths configuration
    'paths' => [
        // Directories containing language files to translate
        'lang_dirs' => [
            'lang',
            'resources/lang',
        ],
        
        // File patterns to include in translation
        'include_patterns' => [
            '*.json',
            '*.php',
        ],
        
        // File patterns to exclude from translation
        'exclude_patterns' => [
            'vendor/**',
            'node_modules/**',
        ],
    ],
];

Usage

AI Translation

This package provides a command to translate your language files using ChatGPT. The command will translate all language files from the source language to the target languages.

Configuration

First, make sure you have set up your OpenAI API key in your .env file:

OPENAI_API_KEY=your-api-key

You can also configure which translation service to use:

AI_TRANSLATION_DRIVER=chatgpt

The source and target languages are configured directly in the config file. You can modify them by publishing the config file and editing the languages section.

Running the Translation Command

To translate all language files:

php artisan translate:ai

You can also specify the source and target languages directly in the command:

php artisan translate:ai --source=en --target=uk,de,fr

By default, the command will skip files that already exist. If you want to force overwrite existing translations, use the --force option:

php artisan translate:ai --force

Supported File Formats

The translation command supports the following file formats:

JSON language files (e.g., en.json)
PHP language files (e.g., resources/lang/en/messages.php)

The translator will maintain the structure of the original files, only translating the values and preserving all laravelAiI18ns and placeholders.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

cargofy / laravel-ai-i18n

Maintainers

Details