coffreo/php-translation-js-extractor-bundle

Add javascript translation extractor for php-translation/symfony-bundle package

v2.1.0 2021-10-22 13:57 UTC

This package is auto-updated.

Last update: 2021-11-22 14:13:43 UTC


README

By Coffreo

PHP from Packagist Build Status Coverage Scrutinizer Code Quality

Extract translations from Javascript source files.

Same bundle exists for JMSTranslation: see Coffreo/jms-translation-js-extractor-bundle

Installation

Application with Symfony flex

composer require coffreo/php-translation-js-extractor-bundle

Application without Symfony flex

  • Install bundle

    composer require coffreo/php-translation-js-extractor-bundle
    
  • Enable bundle:

    • symfony 3.*

      // config/AppKernel.php
      public function registerBundles()
      {
          return array(
              // ...
              new Coffreo\PHPTranslationJsExtractorBundle\CoffreoPHPTranslationJsExtractorBundle(),
              // ...
          );
      }
    • symfony 4.* (if not already added by symfony/flex)

      // config/bundles.php
      
      return [
          // ...
          Coffreo\PHPTranslationJsExtractorBundle\CoffreoPHPTranslationJsExtractorBundle::class => ['all' => true],
      ];

Usage

This bundle allow extraction of translated strings in javascript files using Coffreo/js-translation-extractor.

No specific command line to use, just use originals php-translation/symfony-bundle commands:

$ bin/console translation:extract ....

Translations found are automatically added to current translations files as PHP, twig ones.

Configuration

This bundle doesn't need configuration.
However, to extract strings from JS files, you must indicate where are stored your JS files in php-translation/symfony-bundle configuration.

# paths below are symfony 4.X paths, make sure to change them for sumfony 3.X
# config/packages/php_translation.yaml
translation:
    ...
    configs:
        app:
            dirs: 
              - "%kernel.project_dir%/templates"
              - "%kernel.project_dir%/src"
              - "%kernel.project_dir%/assets"     # <-- add path containing JS files 
            #...

Developer commands

  • Run tests:
composer test
  • Apply coding standard
composer cs

Coding standard must be applied before commit, TravisCI will fail otherwise

License

This project is licensed under the MIT License - see the LICENSE file for details