Please note that this repository is not maintained anymore and will be made private to Meniga no later than on 31 december 2023. Recommend using the official Lokalise Flutter SDK. If you want to start using the Lokalise Flutter SDK, please go to the following page for more information: https://developers.lokalise.com/docs/flutter-sdk

flutter_lokalise

A tool to download translation bundles from Lokalise and convert them to .arb files.

Currently, it supports following commands:

download command

Usage

Add configuration to pubspec.yaml:

dev_dependencies:
  flutter_lokalise: any

flutter_lokalise:
  project_id: YOUR_LOKALISE_PROJECT_ID
  api_token: YOUR_LOKALISE_API_TOKEN
  include_tags:
    - tag1
    - tag2
    
flutter_intl:
  enabled: true

Run flutter_lokalise:

flutter pub run flutter_lokalise \
  [--working-directory <path>] \
  [--api-token <token>] \
  [--project-id <project_id>] \
  <command>

You can also follow how to set up a global command to make it
available as a regular shell command by appending PATH.

flutter_lokalise <command>>

or creating an alias instead:

alias flutter_lokalise="flutter pub run flutter_lokalise"

flutter_lokalise <command>>

download command

Downloads .arb translation files.

flutter_lokalise download \
  [--output <path>] \
  [--include-tags <tag1,tag2,...>]

For example:

flutter_lokalise download

Publishing new version

1. Make sure you have access to meniga.com publisher
2. Bump version in pubspec.yaml
3. Run pub publish --dry-run and check if this package can be published
4. Push commit, get approves and merge to master
5. Checkout master
6. Run pub publish and check if the package was published
7. Go to releases page and create a new release by tagging the current commit