cavernbay/translation-bundle

Symfony Tool to help Import/Export (missing) translations

1.0.4 2023-01-29 17:49 UTC

Requires

• php: ^8.1
• league/csv: ^9.8
• symfony/console: ^5.4|^6.0
• symfony/filesystem: ^5.4|^6.0
• symfony/finder: ^5.4|^6.0
• symfony/yaml: ^5.4|^6.0

Requires (Dev)

• symfony/dependency-injection: ^5.4|^6.0
• symfony/http-kernel: ^5.4|^6.0
• symfony/phpunit-bridge: ^5.4|^6.0

MIT

• Michel NAUD
• Andrius Petrauskis

• symfony
• translation

README

This is a reworked fork of kilik/translation-bundle, adapted to symfony 5 and symfony 6 and php 8.1+. If you need translations for older versions, you can use kilik/translation-bundle instead

CBTB (CavernBay Translation Bundle) is a tool to be used with Symfony Translator. It tries to simplify the exchanges with the (human) translators.

From the command line you can export translations (filtering with bundles names, domains, and locales) to CSV (Tab separators).

Your translator (colleague, service provider, etc...) can open CSV files with specific translator tools (or with Office Software).

Then, you can import updated translations to your project.

The translations made in vendors are also supported (useful when you have to work on big applications with a lot of bundles).

Concepts:

• your project is fully translated in a locale (locale reference, fallback)
• it aims to simplify the process to translate missing translations with non-team people

Add this bundle to your application

composer require cavernbay/translation-bundle

Then, add this line to your bundles.php:

    $bundles = [
        // ...
        new CavernBay\TranslationBundle\CavernBayTranslationBundle(),
        // ...
    ];

Export translations

Export translations to CSV:

export all translations, with EN locale as reference to a file:

./bin/console cb:translation:export en all all ~/translations.csv

export translations, with EN locale as reference, and match missing translations to FR or ES to a file:

./bin/console cb:translation:export en fr,es AcmeBundle ~/translations.csv

work on some bundles at the same time:

./bin/console cb:translation:export en fr,es AcmeBundle,MyOtherBundle ~/translations.csv

export only lines with missing translations:

./bin/console cb:translation:export en fr,es AcmeBundle --only-missing ~/translations.csv

export only some domains:

./bin/console cb:translation:export en fr,es AcmeBundle --domains messages,validators ~/translations.csv

export application only translations:

./bin/console cb:translation:export en fr app ~/translations.csv

Import translations

Import translations from CSV (translations are merged with your current project translations).

import all translations from your CSV file, for a given locales:

./bin/console cb:translation:import fr ~/translations.csv

import all translations from your CSV file, overriding existing translation keys:

./bin/console cb:translation:import fr ~/translations.csv -o

import translations from your CSV file, for a specific bundle, for a given locales:

./bin/console cb:translation:import fr --bundles AcmeBundle ~/translations.csv

import translations from your CSV file, for domains, for a given locales:

./bin/console cb:translation:import fr --domains messages,validators AcmeBundle ~/translations.csv

you can also import translations with many locales:

./bin/console cb:translation:import fr,es,nl ~/translations.csv

import translations from your CSV file, for application only translations (Symfony 3.4+ / Symfony 4+1):

./bin/console cb:translation:import fr --bundles app ~/translations.csv

For bundle developers

# prepare tests
./prepare-tests.sh

# run tests
./run-tests.sh

# launch composer
./scripts/composer.sh