mpociot / laravel-localization-helpers

Laravel Localization Helpers : commands to generate and update lang files automatically and more.

Laravel Localization Helpers

LLH is a set of tools to help you manage translations in your Laravel project.

Installation

1 - Add the following line in the require-dev array of the composer.json file :
"potsky/laravel-localization-helpers" : "~1.1"

2 - Update your installation : composer update

3 - Add the following line in the providers array of the app/config/app.php configuration file : 'Potsky\LaravelLocalizationHelpers\LaravelLocalizationHelpersServiceProvider',

Now execute php artisan list and you should view the new localization commands:

...
key
  key:generate                Set the application key
localization
  localization:find           Display all files where the argument is used as a lemma
  localization:missing        Parse all translations in app directory and build all lang files
migrate
  migrate:install             Create the migration repository
...

Configuration

To configure your fresh installed package, please create a configuration file by executing :

php artisan config:publish potsky/laravel-localization-helpers

Then you can modify the configuration in file app/config/packages/potsky/laravel-localization-helpers/config.php.

Add new folders to search for, add your own lang methods or functions, ...

Usage

Command localization:missing

This command parses all your code and generate according lang files in all lang/XXX/ directories.

Use php artisan help localization:missing for more informations about options.

Examples

Generate all lang files

php artisan localization:missing

Generate all lang files without prompt

php artisan localization:missing -n

Generate all lang files without backuping old files

php artisan localization:missing -b

Generate all lang files without keeping obsolete lemmas

php artisan localization:missing -o

Generate all lang files without any comment for new found lemmas

php artisan localization:missing -c

Generate all lang files without header comment

php artisan localization:missing -d

Generate all lang files and set new lemma values

3 commands below produce the same output:

php artisan localization:missing
php artisan localization:missing -l
php artisan localization:missing -l "%LEMMA"

You can customize the default generated values for unknown lemmas.

The following command let new values empty:

php artisan localization:missing -l ""

The following command prefixes all lemmas values with "Please translate this : "

php artisan localization:missing -l "Please translate this : %LEMMA"

The following command prefixes all lemmas values with "Please translate this !"

php artisan localization:missing -l 'Please translate this !'

Silent option for shell integration

#!/bin/bash

php artisan localization:missing -s
if [ $? -eq 0 ]; then
    echo "Nothing to do dude, GO for release"
else
    echo "I will not release in production, lang files are not clean"
fi

Simulate all operations (do not write anything) with a dry run

php artisan localization:missing -r

Open all must-edit files at the end of the process

php artisan localization:missing -e

You can edit the editor path in your configuration file. By default, editor is Sublime Text on Mac OS X :

    'editor_command_line' => '/Applications/Sublime\\ Text.app/Contents/SharedSupport/bin/subl'

Command localization:find

This command will search in all your code for the argument as a lemma.

Use php artisan help localization:find for more informations about options.

Examples

Find regular lemma

php artisan localization:find Search

Find regular lemma with verbose

php artisan localization:find -v Search

Find regular lemma with short path displayed

php artisan localization:find -s "Search me"

Find lemma with a regular expression

php artisan localization:find -s -r "@Search.*@"
php artisan localization:find -s -r "/.*me$/"

PCRE functions are used

Support

Use the github issue system to open a issue and ask for something.

Change Log

v1.2.2

• add support for @lang and @choice in Blade templates (by Jesper Ekstrand)

v1.2.1

• add lang_folder_path parameter in configuration file to configure the custom location of your lang files
• check lang files in app/lang by default for Laravel 4.x
• check lang files in app/resources/lang by default for Laravel 5

v1.2

• support for Laravel 5 (4.3)
• add ignore_lang_files parameter in configuration file to ignore lang files (useful for validation file for example)