francessco121/dart-embedded-config

Allows Dart application configurations to be embedded directly into source code at build-time.

dart-embedded-config's Issues

Support YAML config file sources

Could use the official Dart YAML parser: https://pub.dev/packages/yaml
File parsing is currently located in _resolveConfig: https://github.com/Francessco121/dart-embedded-config/blob/master/embedded_config/lib/src/config_generator.dart#L139

• Update ConfigGenerator to parse files as YAML with .yaml and .yml extensions.
• Update documentation to say both JSON and YAML are supported.

Support null safety

Looks like the dependencies finally support null safety, so it's time these two packages did as well!

Support JSONC (JSON with comments)

The official Dart JSON serializer doesn't support this, but these third-party packages do:

• https://pub.dev/packages/jsonc
• https://pub.dev/packages/json5

Not sure if bringing in third-party dependencies is the best way to support this...

Support optional config sources

It would be super useful to allow build.yaml configs to specify whether a config source is optional. For example, an app could have a config.local.json file that doesn't exist by default (and is ignored by source control), but developers can create to optionally override config for development. This could allow different developers to use different dev configs without worrying about committing them to a repository.

Could look something like this:

# Multi-source example
targets:
  $default:
    builders:
      embedded_config:
        options:
          app_config:
            source:
              - lib/app_config.json
              - path: lib/app_config.local.json
                optional: true

# Single-source example
targets:
  $default:
    builders:
      embedded_config:
        options:
          app_config:
            # Note: not strictly required, a list with a single item would work 
            # for both multi and single without additional work
            source:
              path: lib/app_config.local.json
              optional: true
            inline:
              key: value

Upgrade analyzer dependency to 2.0.0

This is a major version bump, might require some code changes.