mariuzzo/laravel-js-localization

Laravel Localization in JavaScript

Installs: 8 074

Dependents: 0

Stars: 32

Watchers: 6

Forks: 31

Open Issues: 9

Language: JavaScript

v1.2.1 2015-06-29 02:42 UTC

README

Join the chat at https://gitter.im/rmariuzzo/Laravel-JS-Localization

Laravel Localization in JavaScript.

Laravel 5.1 Laravel 5.0 Laravel 4.2 Latest Stable Version Total Downloads License

This is a simple package that convert all your localization messages of your Laravel app to JavaScript, and provides a small JavaScript library to interact with those messages.

Support Laravel 4.2.x, Laravel 5 and Laravel 5.1.x.

Installation

Add the following line to you composer.json file under require.

"mariuzzo/laravel-js-localization": "1.2.*"

Run:

composer update

In your Laravel app go to app/config/app.php and add the following service provider:

'providers' => array(
    // ...
    'Mariuzzo\LaravelJsLocalization\LaravelJsLocalizationServiceProvider',
    // ...
)

That's it!

Usage

This project comes with a command that generate the JavaScript version of all your messages found at: app/lang or resources/lang directory. The resulting JavaScript file will have the whole bunch of messages and a thin library similar to Laravel's Lang class.

Generating JS messages

php artisan lang:js

Specifying a custom target

php artisan lang:js public/assets/dist/lang.dist.js

Compressing the JS file

php artisan lang:js -c

Use gulp to publish (optional):

install gulp-shell from https://github.com/sun-zheng-an/gulp-shell with npm install --save-dev gulp-shell and then run it directly in your gulpfile.js:

var shell = require('gulp-shell');

//......

gulp.task('langJs', shell.task('php artisan lang:js -c public/js/messages.js'));

or you can extend Laravel's elixir like this:

elixir.extend("langjs", function(path) {
    gulp.task("langjs", function() {
        gulp.src("").pipe(shell("php artisan lang:js " + (path || "public/js/messages.js")));
    });

    return this.queueTask("langjs");
});

and use it like this:

elixir(function(mix) {

    mix.langjs();

});

Documentation

This is the documentation regarding the thin JavaScript library. The library highly inspired on Laravel's Lang class.

Getting a message

Lang.get('messages.home');

Getting a message with replacements

Lang.get('messages.welcome', { name: 'Joe' });

Changing the locale

Lang.setLocale('es');

Checking if a message key exists

Lang.has('messages.foo');

Support for singular and plural message based on a count

Lang.choice('messages.apples', 10);

Calling the choice method with replacements

Lang.choice('messages.apples', 10, { name: 'Joe' });

For more detailed information, take a look at the source: Lang.js.

Want to contribute?

  1. Fork this repository and clone it.
  2. Create a branch from develop: git checkout -b feature-foo.
  3. Push your commits and create a pull request.

Setting up development environment

Prerequisites:

You need to have installed the following softwares.

  • Composer.
  • NodeJS.
  • NPM.
  • PHP 5.4+.

After getting all the required softwares you may run the following commands to get everything ready:

  1. Install PHP dependencies:

    composer install
  2. Install NPM dependences:

    npm install -g jasmine-node
    
    npm install

Now you are good to go! Happy coding!

Unit testing

This project use Jasmine-Node and PHPUnit. All tests are stored at tests directory.

To run all JS tests type in you terminal:

npm test

To run all PHP tests type in your terminal:

phpunit