json_locale_generator 0.2.0

A generation tool that builds a class to get your json locale paths from dart code

A generation tool that builds a class to get your json locale paths from dart code.

Getting started

1. Add dependencies in your pubspec.yaml:

dev_dependencies:
  json_locale_generator: ^0.2.0
  build_runner: ^2.0.4

2. Configure the json files to generate code for in your pubspec.yaml:

json_to_dart:
  sample_files:
    # The file assets/en.json will be converted to dart code and values can be accessed via the Locale class
    - source: assets/en.json
      class_name: Locale
    - source: assets/other.json
      class_name: Other

3. Execute [dart|flutter] pub run build_runner build. The file jsons.dart will be generated into lib/jsons.dart
4. Import jsons.dart and start using it:

import 'jsons.dart';

FlutterI18n.translate(context, Locale.core.app_title);

5. To avoid warnings in the generated code, add lib/jsons.dart to your analysis_options.yaml file:

analyzer:
  exclude:
    - lib/jsons.dart

Features

Converts a json such as

{
  "ok": "OK",
  "core": {
    "app_name": "WordSing Battle"
  },
  "home": {
    "title": "No card in the deck"
  }
}

To dart code where each path can be accessed easily. For above example, doing GeneratedClass.core.app_name will return the String 'core.app_name'

JsonKeys that are keywords in dart (continue, if...) are generated with a trailing underscore (continue_, if_)

JsonKeys that have non proper characters in their names (non alphanum + _ characters) will have these characters replaced by '_'

JsonKeys that start with a number will have this number put at the end, prefixed by an underscore: 0word will be word_0 in dart code

Plural values

Group keys using a regexp. Set the property plural_match of a source to a regexp. Sibling keys that have a part matching this regexp will be grouped under the same non-matching part of the regexp.

Example

{
  "word-0": "Word",
  "word-1": "Word",
  "word-2": "Words"
}

is converted to

Locale {

static const String word = 'word';}

provided your pubspec.yaml file is

json_to_dart:
  sample_files:
    - source: <source_file>
      class_name: Locale
      plural_matcher: "-[0-9]+$"

Json restrictions:

• Json keys cannot contain . $ and \
• Non alphabetic (or underscores) key starts are sent back at the end of the generated dart property: 12key json key turns to key_12 dart property
• Characters that are neither letters, numbers no _ are changed to _ in generated dart property name: key-part json key turns to key_part dart property
• Json keys that are dart reserved keywords are followed by _ in property name: break json key turns to break_ dart property