Laravel Poeditor Synchronization

Upload and download POEditor translations. Both PHP and JSON translation files are supported. Vendor PHP / JSON translations can also be uploaded / downloaded.

Installation

You can install the package via composer:

composer require nextapps/laravel-poeditor-sync --dev

You can publish the configuration file:

php artisan vendor:publish --provider="NextApps\PoeditorSync\PoeditorSyncServiceProvider"

Set the POEditor API key and Project ID in your env-file:

POEDITOR_API_KEY=<your api key>
POEDITOR_PROJECT_ID=<your project id>

In the 'poeditor-sync' configuration file, you should specify the supported locales. You can also provide an associate array, if you want to map POEditor locales to internal locales.

// in config/poeditor-sync.php

// Provide array with all supported locales ...
'locales' => ['en', 'nl', 'fr'],

// ... Or provide associative array with POEditor locales mapped to internal locales
'locales' => ['en-gb' => 'en', 'nl-be' => 'nl'],

// ... Or you can map multiple internal locales to the same POEditor locale
'locales' => ['nl' => ['nl_BE', 'nl_NL']],

Usage

Download translations

All translations in all supported locales will be downloaded.

php artisan poeditor:download

Upload Translations

Upload translations of the default app locale:

php artisan poeditor:upload

Upload translations of specified locale:

php artisan poeditor:upload nl

Upload translations and overwrite existing POEditor translations:

php artisan poeditor:upload --force

Testing

composer test

Linting

composer lint

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

License

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

nextapps-be / laravel-poeditor-sync