incenteev/translation-checker-bundle

CLI tools to check translations in a Symfony project

v1.9.1 2024-01-16 14:54 UTC

Requires

• php: ^7.4 || ^8.0
• symfony/config: ^4.4.29 || ^5.3.4 || ^6.0.0 || ^7.0.0
• symfony/console: ^4.4.29 || ^5.3.4 || ^6.0.0 || ^7.0.0
• symfony/dependency-injection: ^4.4.29 || ^5.3.4 || ^6.0.0 || ^7.0.0
• symfony/finder: ^4.4.29 || ^5.3.4 || ^6.0.0 || ^7.0.0
• symfony/framework-bundle: ^4.4.29 || ^5.3.4 || ^6.0.0 || ^7.0.0
• symfony/http-kernel: ^4.4.29 || ^5.3.4 || ^6.0.0 || ^7.0.0
• symfony/translation: ^4.4.32 || ^5.3.4 || ^6.0.0 || ^7.0.0
• symfony/yaml: ^4.4.29 || ^5.3.4 || ^6.0.0 || ^7.0.0

Requires (Dev)

• jangregor/phpstan-prophecy: ^1.0
• phpspec/prophecy-phpunit: ^2.0
• phpstan/phpstan: ^1.10
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-symfony: ^1.3
• phpunit/phpunit: ^9.6.15
• symfony/phpunit-bridge: ^6.4.0 || ^7.0.0

MIT

• Christophe Coevoet

• translation
• testing
• translation check

README

This bundle provides you a few CLI commands to check your translations. These commands are designed to be usable easily in CI jobs

Installation

Installation is a quick (I promise!) 2 step process:

1. Download IncenteevTranslationCheckerBundle
2. Enable the Bundle

Step 1: Install IncenteevTranslationCheckerBundle with composer

Run the following composer require command:

$ composer require incenteev/translation-checker-bundle

Step 2: Enable the bundle

Note: If you use Flex, you have nothing to do at this step, as Flex does it for you.

Finally, enable the bundle in the kernel:

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Incenteev\TranslationCheckerBundle\IncenteevTranslationCheckerBundle(),
    );
}

Warning: This bundle requires that the translator is enabled in FrameworkBundle.

Usage

The bundle provides a few CLI commands. To list them all, run:

$ bin/console list incenteev:translation

All commands display a summary only by default. Run then in verbose mode to get a detailed report.

Finding missing translations

The incenteev:translation:find-missing command extracts necessary translations from our app source code, and then compare this list to the translation available for the tested locale. It will exit with a failure exit code if any missing translation is detected.

Warning: Translation extraction will not find all translations used by our app. So while a failure exit code means there is an issue, a success exit code does not guarantee that all translations are available. The recommended usage is to use this command for your reference locale only, and then test other locales by comparing them against the reference instead.

Comparing translations to a reference locale

The incenteev:translation:compare command compares available translations from 2 different locales and will exit with a failure exit code if catalogues are not in sync.

Note: this command may not work well for country variants of a locale (fr_FR). Use it for main locales.

Configuration

To use the commands comparing the catalogue to the extracted translations, you need to configure the bundles in which the templates should be parsed for translations. By default, only templates in templates (and app/Resources/views on Symfony 4 and older) are registered in the extractor. You can register bundles that will be processed too.

# app/config/config.yml
incenteev_translation_checker:
    extraction:
        bundles:
            - TwigBundle
            - AcmeDemoBundle

The bundle also supports extracting translations from JS files, for projects using willdurand/js-translation-bundle:

# app/config/config.yml
incenteev_translation_checker:
    extraction:
        js:
            # Paths in which JS files should be checked for translations.
            # Path could be either for files, or for directories in which JS files should be looked for.
            # This configuration is required to enable this feature.
            paths:
                - '%kernel.project_dir%/web/js'
                - '%kernel.project_dir%/web/other.js'
            # The default domain used in your JS translations. Should match the js-translation-bundle configuration
            # Defaults to 'messages'
            default_domain: js