Download the PHP package michele-angioni/laravel-js-lang-converter without Composer
On this page you can find all versions of the php package michele-angioni/laravel-js-lang-converter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download michele-angioni/laravel-js-lang-converter
More information about michele-angioni/laravel-js-lang-converter
Files in michele-angioni/laravel-js-lang-converter
Package laravel-js-lang-converter
Short Description Laravel Localization in JavaScript
License MIT
Homepage https://github.com/michele-angioni/laravel-js-lang-converter
Informations about the package laravel-js-lang-converter
Laravel JS Lang Converter
Laravel Localization in JavaScript.
Laravel JS Lang Converter converts all your localization messages of your Laravel app to JavaScript, providing a small JavaScript library to interact with those messages in the fron end.
Most of the work has been developed in Mariuzzo's package
Laravel 5.5+ is supported. PHP 7.0 is required. For Laravel 5.1 - 5-4 versions, use the v2.x branch.
Installation
Add the following line to you composer.json
file under require
.
and run composer update
or composer install
.
Then you need to add the Laravel JS Lang Converter service provider in your app/config/app.php
file
In order to use some package features, you need to publish the config file through the artisan command php artisan vendor:publish
. It will create the laravel_js_lang.php
file in your config directory.
Now you are done!
Usage
This project comes with a command that generate the JavaScript version of all your messages found in 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
Specifying a custom target
Converting only some files
If you don't want to convert ALL your lang files, you can specify the files you want to be converted into your laravel_js_lang.php
conf file. Under the files
array, just add the list of your source files, like so:
Compressing the JS file
Use gulp to publish (optional):
-
Install
gulp-shell
from https://github.com/sun-zheng-an/gulp-shell withnpm install --save-dev gulp-shell
. -
Create an extension for elixir in your
gulpfile.js
: - Use the new elixir task:
Documentation
This is the documentation regarding the thin JavaScript library. The library is highly inspired on Laravel's Lang
class.
Getting a message
Getting a message with replacements
Changing the locale
Checking if a message key exists
Support for singular and plural message based on a count
Calling the choice
method with replacements
For more detailed information, take a look at the source: Lang.js.
How to contribute
Pull requests are welcome.
- Fork this repository and clone it.
- Create a branch from develop:
git checkout -b feature-foo
. - 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 7.0+
After getting all the required software you may run the following commands to get everything ready:
-
Install PHP dependencies:
- Install NPM dependences:
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:
To run all PHP tests type in your terminal: