Giter Club home page Giter Club logo

laravel-lokalise's Introduction

Laravel Lokalise

Latest Version on Packagist Total Downloads GitHub Actions

Lokalise states, that they support Laravel translations, but out of the box this is not the case.
They do not support Laravels placeholders and also not its pluralization. In Laravel it is also common to use two translation files. Multiple PHP files per locale which contain nested keys and also one JSON file per locale which uses the base locale as key.
This package provides a simple way to sync your Laravel translations with Lokalise without changing anything in your translations nor in your lokalise settings. It just works!

How does it work?

The package does a few things to give the best out-of-the-box experience.
It checks your JSON and PHP translations separately.
Dotted translation keys will get prefixed by the file name.
The translations are then processed on the fly to convert placeholders and pluralization to Lokalise compatible formats.
It then uploads the files to Lokalise.
Downloading translations works a bit different since Lokalise converts the placeholders to a non-reversible format when downloading whole files. Therefor the package makes usage of the translation keys API to fetch keys file per file. Before it dumps the keys into their respective files, it converts the placeholders back to the Laravel format.

Installation

You can install the package via composer.

composer require bambamboole/laravel-lokalise

Add the following environment variables to your .env file:

LOKALISE_API_TOKEN=your-lokalise-api-token
LOKALISE_PROJECT_ID=your-lokalise-project-id

Usage

The package is still in its early development and therefor pretty opinionated and not very flexible.

To upload your translations to Lokalise you can run the following command:

php artisan lokalise:upload

To upload only specific files You can add relative file path directly behind the command

php artisan lokalise:upload lang/en.json lang/en/validation.php
# or for CI
git diff --name-only | grep lang/ | xargs php artisan lokalise:upload

You can add the --cleanup flag to remove all translations from Lokalise which are not in your project anymore. If you add it without specifying files it will also remove all keys from files which do not exist anymore

To download your translations from Lokalise you can run the following command:

php artisan lokalise:download

Testing

composer test

Contributing

Ideas/Roadmap

  • Add more tests
  • Do not override existing lokal translations on lokalise:download. Update existing and keep new
  • Support multi pluralisation like 'apples' => '{0} There are none|[1,19] There are some|[20,*] There are many'
  • Your idea here

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

laravel-lokalise's People

Contributors

bambamboole avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.